Interface to be implemented by flow state. More...
Public Member Functions | |
| string | GetName () |
| The name of the state. Should be unique within a flow. More... | |
| FlowExecutionStatus | Handle (IFlowExecutor executor) |
| Handle some business or processing logic and return a status that can be used to drive a flow to the next IState. The status can be any string, but special meaning is assigned to the static constants in FlowExecution. The context can be used by implementations to do whatever they need to do. The same context will be passed to all IState instances, so implementations should be careful that the context is thread-safe, or used in a thread-safe manner. More... | |
| bool | IsEndState () |
| Inquire as to whether a IState is an end state. Implementations should return false if processing can continue, even if that would require a restart. More... | |
Detailed Description
Interface to be implemented by flow state.
Member Function Documentation
| string Summer.Batch.Core.Job.Flow.IState.GetName | ( | ) |
The name of the state. Should be unique within a flow.
- Returns
- The name of the state
Implemented in Summer.Batch.Core.Job.Flow.Support.State.AbstractState.
| FlowExecutionStatus Summer.Batch.Core.Job.Flow.IState.Handle | ( | IFlowExecutor | executor | ) |
Handle some business or processing logic and return a status that can be used to drive a flow to the next IState. The status can be any string, but special meaning is assigned to the static constants in FlowExecution. The context can be used by implementations to do whatever they need to do. The same context will be passed to all IState instances, so implementations should be careful that the context is thread-safe, or used in a thread-safe manner.
- Parameters
-
executor
- Returns
- Exceptions
-
System.Exception
Implemented in Summer.Batch.Core.Job.Flow.Support.State.EndState, Summer.Batch.Core.Job.Flow.Support.State.StepState, Summer.Batch.Core.Job.Flow.Support.State.SplitState, Summer.Batch.Core.Job.Flow.Support.State.AbstractState, and Summer.Batch.Core.Job.Flow.Support.State.FlowState.
| bool Summer.Batch.Core.Job.Flow.IState.IsEndState | ( | ) |
Inquire as to whether a IState is an end state. Implementations should return false if processing can continue, even if that would require a restart.
- Returns
- true if this IState is the end of processing
Implemented in Summer.Batch.Core.Job.Flow.Support.State.EndState, Summer.Batch.Core.Job.Flow.Support.State.SplitState, Summer.Batch.Core.Job.Flow.Support.State.StepState, Summer.Batch.Core.Job.Flow.Support.State.AbstractState, and Summer.Batch.Core.Job.Flow.Support.State.FlowState.
The documentation for this interface was generated from the following file:
- Summer.Batch.Core/Core/Job/Flow/IState.cs