Summer.Batch.Core.Job.Flow.IFlow Interface Reference
Interface to be implemented by flows. More...
Inheritance diagram for Summer.Batch.Core.Job.Flow.IFlow:
Public Member Functions | |
| string | GetName () |
| IState | GetState (string stateName) |
| Retrieve the IState with the given name. If there is no State with the given name, then return null. More... | |
| FlowExecution | Start (IFlowExecutor executor) |
| Starts the flow, using given executor. More... | |
| FlowExecution | Resume (string currentStateName, IFlowExecutor executor) |
| Resumes the flow. More... | |
| ICollection< IState > | GetStates () |
| Convenient accessor for clients needing to explore the states of this flow. More... | |
Detailed Description
Interface to be implemented by flows.
Member Function Documentation
| string Summer.Batch.Core.Job.Flow.IFlow.GetName | ( | ) |
- Returns
- the name of the flow
Implemented in Summer.Batch.Core.Job.Flow.Support.SimpleFlow.
| IState Summer.Batch.Core.Job.Flow.IFlow.GetState | ( | string | stateName | ) |
Retrieve the IState with the given name. If there is no State with the given name, then return null.
- Parameters
-
stateName
- Returns
Implemented in Summer.Batch.Core.Job.Flow.Support.SimpleFlow.
| ICollection<IState> Summer.Batch.Core.Job.Flow.IFlow.GetStates | ( | ) |
Convenient accessor for clients needing to explore the states of this flow.
- Returns
Implemented in Summer.Batch.Core.Job.Flow.Support.SimpleFlow.
| FlowExecution Summer.Batch.Core.Job.Flow.IFlow.Resume | ( | string | currentStateName, |
| IFlowExecutor | executor | ||
| ) |
Resumes the flow.
- Parameters
-
currentStateName the name of the state to resume on executor the context to be passed into each state executed
- Returns
- a FlowExecution containing the exit status of the flow
- Exceptions
-
FlowExecutionException
Implemented in Summer.Batch.Core.Job.Flow.Support.SimpleFlow.
| FlowExecution Summer.Batch.Core.Job.Flow.IFlow.Start | ( | IFlowExecutor | executor | ) |
Starts the flow, using given executor.
- Parameters
-
executor
- Returns
- Exceptions
-
FlowExecutionException
Implemented in Summer.Batch.Core.Job.Flow.Support.SimpleFlow.
The documentation for this interface was generated from the following file:
- Summer.Batch.Core/Core/Job/Flow/IFlow.cs