Context and execution strategy for FlowJob to allow it to delegate its execution step by step. More...
Public Member Functions | |
| string | ExecuteStep (IStep step) |
| Executes the given step. More... | |
| JobExecution | GetJobExecution () |
| StepExecution | GetStepExecution () |
| void | Close (FlowExecution result) |
| Chance to clean up resources at the end of a flow (whether it completed successfully or not). More... | |
| void | AbandonStepExecution () |
| Handle any status changes that might be needed at the start of a state. More... | |
| void | UpdateJobExecutionStatus (FlowExecutionStatus status) |
| Handle any status changes that might be needed in the JobExecution. More... | |
| bool | IsRestart () |
| void | AddExitStatus (string code) |
Detailed Description
Context and execution strategy for FlowJob to allow it to delegate its execution step by step.
Member Function Documentation
| void Summer.Batch.Core.Job.Flow.IFlowExecutor.AbandonStepExecution | ( | ) |
Handle any status changes that might be needed at the start of a state.
Implemented in Summer.Batch.Core.Job.Flow.JobFlowExecutor.
| void Summer.Batch.Core.Job.Flow.IFlowExecutor.AddExitStatus | ( | string | code | ) |
- Parameters
-
code code the label for the exit status when a flow or sub-flow ends
Implemented in Summer.Batch.Core.Job.Flow.JobFlowExecutor.
| void Summer.Batch.Core.Job.Flow.IFlowExecutor.Close | ( | FlowExecution | result | ) |
Chance to clean up resources at the end of a flow (whether it completed successfully or not).
- Parameters
-
result the final FlowExecution
Implemented in Summer.Batch.Core.Job.Flow.JobFlowExecutor.
| string Summer.Batch.Core.Job.Flow.IFlowExecutor.ExecuteStep | ( | IStep | step | ) |
Executes the given step.
- Parameters
-
step an IStep to execute
- Returns
- the exit status that drives the surrounding Flow
- Exceptions
-
JobInterruptedException JobRestartException StartLimitExceededException
Implemented in Summer.Batch.Core.Job.Flow.JobFlowExecutor.
| JobExecution Summer.Batch.Core.Job.Flow.IFlowExecutor.GetJobExecution | ( | ) |
- Returns
- the current JobExecution
Implemented in Summer.Batch.Core.Job.Flow.JobFlowExecutor.
| StepExecution Summer.Batch.Core.Job.Flow.IFlowExecutor.GetStepExecution | ( | ) |
- Returns
- the latest StepExecution or null if there is none
Implemented in Summer.Batch.Core.Job.Flow.JobFlowExecutor.
| bool Summer.Batch.Core.Job.Flow.IFlowExecutor.IsRestart | ( | ) |
- Returns
- true if the flow is at the beginning of a restart
Implemented in Summer.Batch.Core.Job.Flow.JobFlowExecutor.
| void Summer.Batch.Core.Job.Flow.IFlowExecutor.UpdateJobExecutionStatus | ( | FlowExecutionStatus | status | ) |
Handle any status changes that might be needed in the JobExecution.
- Parameters
-
status
Implemented in Summer.Batch.Core.Job.Flow.JobFlowExecutor.
The documentation for this interface was generated from the following file:
- Summer.Batch.Core/Core/Job/Flow/IFlowExecutor.cs