Interface State

    • Method Detail

      • getName

        java.lang.String getName()
        The name of the state. Should be unique within a flow.
        Returns:
        the name of this state
      • handle

        FlowExecutionStatus handle​(FlowExecutor executor)
                            throws java.lang.Exception
        Handle some business or processing logic and return a status that can be used to drive a flow to the next State. 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 State instances, so implementations should be careful that the context is thread-safe, or used in a thread-safe manner.
        Parameters:
        executor - the context passed in by the caller
        Returns:
        a status for the execution
        Throws:
        java.lang.Exception - if anything goes wrong
      • isEndState

        boolean isEndState()
        Inquire as to whether a State is an end state. Implementations should return false if processing can continue, even if that would require a restart.
        Returns:
        true if this State is the end of processing