Package org.springframework.batch.core.job.flow

Interface Flow

All Known Implementing Classes:
SimpleFlow
public interface Flow
Since:
2.0
Author:
Dave Syer

  • Method Details

    • getName

      String getName()
      Returns:
      the name of the flow

    • getState

      State getState(String stateName)
      Retrieve the State with the given name. If there is no State with the given name, then return null.
      Parameters:
      stateName - the name of the state to retrieve
      Returns:
      the State

    • start

      FlowExecution start(FlowExecutor executor) throws FlowExecutionException
      Parameters:
      executor - the FlowExecutor instance to use for the flow execution.
      Returns:
      a FlowExecution containing the exit status of the flow.
      Throws:
      FlowExecutionException - thrown if error occurs during flow execution.

    • resume

      FlowExecution resume(String stateName, FlowExecutor executor) throws FlowExecutionException
      Parameters:
      stateName - 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.
      Throws:
      FlowExecutionException - thrown if error occurs during flow execution.

    • getStates

      Collection<State> getStates()
      Convenient accessor for clients needing to explore the states of this flow.
      Returns:
      the states