Summer.Batch.Core.Job.Flow.Support.SimpleFlow Class Reference

An IFlow that branches conditionally depending on the exit status of the last IState. The input parameters are the state transitions (in no particular order). The start state name can be specified explicitly (and must exist in the set of transitions), or computed from the existing transitions, if unambiguous. More...

Inheritance diagram for Summer.Batch.Core.Job.Flow.Support.SimpleFlow:
Summer.Batch.Core.Job.Flow.IFlow Summer.Batch.Common.Factory.IInitializationPostOperations

Public Member Functions

void AfterPropertiesSet ()
 Performs post-initialization checks. see IInitializationPostOperations::AfterPropertiesSet . More...
 
 SimpleFlow (string name)
 Constructor using a name. More...
 
string GetName ()
 
IState GetState (string stateName)
 
FlowExecution Start (IFlowExecutor executor)
 
FlowExecution Resume (string stateName, IFlowExecutor executor)
 
ICollection< IStateGetStates ()
 

Protected Member Functions

IState NextState (string stateName, FlowExecutionStatus status, StepExecution stepExecution)
 Returns the next IStep (or null if this is the end). More...
 
bool IsFlowContinued (IState state, FlowExecutionStatus status, StepExecution stepExecution)
 Tests if flow is continued. More...
 

Properties

IState StartState [get]
 Start state property. More...
 
IDictionary< string, ICollection< StateTransition > > TransitionMap [get]
 Transitions dictionary More...
 
IDictionary< string, IStateStateMap [get]
 States dictionary. More...
 
List< StateTransitionStateTransitions [set]
 List of state transitions property. More...
 
string Name [get]
 Name property. More...
 
IComparer< StateTransitionStateTransitionComparer [set]
 State transition comparer. More...
 

Detailed Description

An IFlow that branches conditionally depending on the exit status of the last IState. The input parameters are the state transitions (in no particular order). The start state name can be specified explicitly (and must exist in the set of transitions), or computed from the existing transitions, if unambiguous.

Constructor & Destructor Documentation

Summer.Batch.Core.Job.Flow.Support.SimpleFlow.SimpleFlow ( string  name)

Constructor using a name.

Parameters
name

Member Function Documentation

void Summer.Batch.Core.Job.Flow.Support.SimpleFlow.AfterPropertiesSet ( )

Performs post-initialization checks. see IInitializationPostOperations::AfterPropertiesSet .

Exceptions
Exception 

Implements Summer.Batch.Common.Factory.IInitializationPostOperations.

string Summer.Batch.Core.Job.Flow.Support.SimpleFlow.GetName ( )

See also
IFlow::GetName .
Returns

Implements Summer.Batch.Core.Job.Flow.IFlow.

IState Summer.Batch.Core.Job.Flow.Support.SimpleFlow.GetState ( string  stateName)

See also
IFlow::GetState .
Parameters
stateName
Returns

Implements Summer.Batch.Core.Job.Flow.IFlow.

ICollection<IState> Summer.Batch.Core.Job.Flow.Support.SimpleFlow.GetStates ( )

See also
IFlow::GetStates .
Returns

Implements Summer.Batch.Core.Job.Flow.IFlow.

bool Summer.Batch.Core.Job.Flow.Support.SimpleFlow.IsFlowContinued ( IState  state,
FlowExecutionStatus  status,
StepExecution  stepExecution 
)
protected

Tests if flow is continued.

Parameters
state
status
stepExecution
Returns
IState Summer.Batch.Core.Job.Flow.Support.SimpleFlow.NextState ( string  stateName,
FlowExecutionStatus  status,
StepExecution  stepExecution 
)
protected

Returns the next IStep (or null if this is the end).

Parameters
stateName
status
stepExecution
Returns
Exceptions
FlowExecutionException 
FlowExecution Summer.Batch.Core.Job.Flow.Support.SimpleFlow.Resume ( string  stateName,
IFlowExecutor  executor 
)

See also
IFlow::Resume .
Parameters
stateName
executor
Returns
Exceptions
FlowExecutionException 

Implements Summer.Batch.Core.Job.Flow.IFlow.

FlowExecution Summer.Batch.Core.Job.Flow.Support.SimpleFlow.Start ( IFlowExecutor  executor)

See also
IFlow::Start .
Parameters
executor
Returns
Exceptions
FlowExecutionException 

Implements Summer.Batch.Core.Job.Flow.IFlow.

Property Documentation

string Summer.Batch.Core.Job.Flow.Support.SimpleFlow.Name
get

Name property.

IState Summer.Batch.Core.Job.Flow.Support.SimpleFlow.StartState
get

Start state property.

IDictionary<string, IState> Summer.Batch.Core.Job.Flow.Support.SimpleFlow.StateMap
getprotected

States dictionary.

IComparer<StateTransition> Summer.Batch.Core.Job.Flow.Support.SimpleFlow.StateTransitionComparer
set

State transition comparer.

List<StateTransition> Summer.Batch.Core.Job.Flow.Support.SimpleFlow.StateTransitions
set

List of state transitions property.

IDictionary<string, ICollection<StateTransition> > Summer.Batch.Core.Job.Flow.Support.SimpleFlow.TransitionMap
getprotected

Transitions dictionary


The documentation for this class was generated from the following file:
  • Summer.Batch.Core/Core/Job/Flow/Support/SimpleFlow.cs