org.bonitasoft.engine.core.process.instance.api.states

Interface State<T>

All Known Subinterfaces:

FlowNodeState

All Known Implementing Classes:

AbortedFlowNodeStateImpl, AbortingActivityWithBoundaryStateImpl, AbortingBoundaryAndIntermediateCatchEventStateImpl, AbortingCallActivityStateImpl, AbortingFlowNodeContainerStateImpl, AbortingFlowNodeStateImpl, AbortingReceiveTaskStateImpl, CancelledFlowNodeStateImpl, CancellingActivityWithBoundaryStateImpl, CancellingBoundaryAndIntermediateCatchEventStateImpl, CancellingCallActivityStateImpl, CancellingFlowNodeContainerChildrenStateImpl, CancellingFlowNodeStateImpl, CancellingReceiveTaskStateImpl, CompletedActivityStateImpl, CompletingActivityStateImpl, CompletingActivityWithBoundaryStateImpl, CompletingCallActivityStateImpl, CompletingSubTaskStateImpl, EndingActivityWithBoundaryStateImpl, EndingCallActivityExceptionStateImpl, EndingFlowNodeContainerExceptionStateImpl, EndingIntermediateCatchEventExceptionStateImpl, ExecutingAutomaticActivityStateImpl, ExecutingBoundaryEventStateImpl, ExecutingCallActivityStateImpl, ExecutingFlowNodeStateImpl, ExecutingLoopActivityStateImpl, ExecutingMultiInstanceActivityStateImpl, ExecutingThrowEventStateImpl, FailedActivityStateImpl, InitializingActivityStateImpl, InitializingActivityWithBoundaryEventsStateImpl, InitializingAndExecutingFlowNodeStateImpl, InitializingBoundaryEventStateImpl, InitializingLoopActivityStateImpl, InitializingMultiInstanceActivityStateImpl, InterruptedFlowNodeState, OnEnterAndFinishConnectorState, OnEnterConnectorState, OnEnterOrOnFinishConnectorState, OnFinishConnectorState, ReadyActivityStateImpl, SkippedFlowNodeStateImpl, WaitingFlowNodeStateImpl

public interface State<T>

Author:

Baptiste Mesta

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_ACTIVITY_EXECUTING
static int	ID_ACTIVITY_FAILED
static int	ID_ACTIVITY_READY

Method Summary

Modifier and Type	Method and Description
StateCode	execute(SProcessDefinition processDefinition, T instance)
int	getId()
java.lang.String	getName()
SStateCategory	getStateCategory() Get the state's category
boolean	hit(SProcessDefinition processDefinition, T parentInstance, T childInstance) Called when a children of the flow node parentInstance finish
boolean	isInterrupting()
boolean	isStable()
boolean	isTerminal() Checks whether the state is a terminal one.

Field Detail

ID_ACTIVITY_EXECUTING

static final int ID_ACTIVITY_EXECUTING

See Also:

Constant Field Values

ID_ACTIVITY_READY

static final int ID_ACTIVITY_READY

See Also:

Constant Field Values

ID_ACTIVITY_FAILED

static final int ID_ACTIVITY_FAILED

See Also:

Constant Field Values

Method Detail

execute

StateCode execute(SProcessDefinition processDefinition,
                  T instance)
           throws SActivityStateExecutionException

Throws:

SActivityStateExecutionException

hit

boolean hit(SProcessDefinition processDefinition,
            T parentInstance,
            T childInstance)
     throws SActivityStateExecutionException

Called when a children of the flow node parentInstance finish

Returns:

true if the state is finished (the execution will continue automatically)

Throws:

SActivityStateExecutionException

getId

int getId()

getName

java.lang.String getName()

isInterrupting

boolean isInterrupting()

Returns:

true if the state is an interrupting state

isStable

boolean isStable()

Returns:

true if the state is stable a final state is stable

isTerminal

boolean isTerminal()

Checks whether the state is a terminal one.

Returns:

true is the state is a terminal one; false otherwise

getStateCategory

SStateCategory getStateCategory()

Get the state's category

Returns:

the state's category