Package org.bonitasoft.engine.execution.state

Class CancellingFlowNodeState

java.lang.Object

org.bonitasoft.engine.execution.state.CancellingFlowNodeState

All Implemented Interfaces:

FlowNodeState

@Component
public class CancellingFlowNodeState
extends java.lang.Object
implements FlowNodeState

Field Summary

Fields inherited from interface org.bonitasoft.engine.core.process.instance.api.states.FlowNodeState

ID_ACTIVITY_EXECUTING, ID_ACTIVITY_FAILED, ID_ACTIVITY_READY

Constructor Summary

Constructors

Constructor	Description
CancellingFlowNodeState()

Method Summary

Modifier and Type	Method	Description
StateCode	execute(SProcessDefinition processDefinition, SFlowNodeInstance instance)
int	getId()
java.lang.String	getName()
SStateCategory	getStateCategory()	Get the state's category
java.lang.String	getSystemComment(SFlowNodeInstance flowNodeInstance)	Add a system comment "User XYZ has XYZ(state change) task XYZ(task name)"
boolean	isStable()
boolean	isTerminal()	Checks whether the state is a terminal one.
boolean	mustAddSystemComment(SFlowNodeInstance flowNodeInstance)	Return true if flowNodeInstance instance of SHumanTaskInstance
boolean	notifyChildFlowNodeHasFinished(SProcessDefinition processDefinition, SFlowNodeInstance parentInstance, SFlowNodeInstance childInstance)	Called when a child of the flow node parentInstance finishes.
boolean	shouldExecuteState(SProcessDefinition processDefinition, SFlowNodeInstance flowNodeInstance)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CancellingFlowNodeState

public CancellingFlowNodeState()

Method Detail

shouldExecuteState

public boolean shouldExecuteState(SProcessDefinition processDefinition,
                                  SFlowNodeInstance flowNodeInstance)

Specified by:

shouldExecuteState in interface FlowNodeState

Returns:

true the state must be executed, false if the execution must skip this state and go directly to the next one

execute

public StateCode execute(SProcessDefinition processDefinition,
                         SFlowNodeInstance instance)

Specified by:

execute in interface FlowNodeState

notifyChildFlowNodeHasFinished

public boolean notifyChildFlowNodeHasFinished(SProcessDefinition processDefinition,
                                              SFlowNodeInstance parentInstance,
                                              SFlowNodeInstance childInstance)

Description copied from interface: FlowNodeState

Called when a child of the flow node parentInstance finishes. Triggers what's next, if applicable. returns if all children activity is finished / triggered.

Specified by:

notifyChildFlowNodeHasFinished in interface FlowNodeState

Returns:

true if the state is finished (the flow node will continue its flow), false if there are still some children to be triggered / to wait for.

getId

public int getId()

Specified by:

getId in interface FlowNodeState

getName

public java.lang.String getName()

Specified by:

getName in interface FlowNodeState

isStable

public boolean isStable()

Specified by:

isStable in interface FlowNodeState

Returns:

true if the state is stable a final state is stable

isTerminal

public boolean isTerminal()

Description copied from interface: FlowNodeState

Checks whether the state is a terminal one.

Specified by:

isTerminal in interface FlowNodeState

Returns:

true is the state is a terminal one; false otherwise

getStateCategory

public SStateCategory getStateCategory()

Description copied from interface: FlowNodeState

Get the state's category

Specified by:

getStateCategory in interface FlowNodeState

Returns:

the state's category

mustAddSystemComment

public boolean mustAddSystemComment(SFlowNodeInstance flowNodeInstance)

Description copied from interface: FlowNodeState

Return true if flowNodeInstance instance of SHumanTaskInstance

Specified by:

mustAddSystemComment in interface FlowNodeState

Returns:

true or false

getSystemComment

public java.lang.String getSystemComment(SFlowNodeInstance flowNodeInstance)

Description copied from interface: FlowNodeState

Add a system comment "User XYZ has XYZ(state change) task XYZ(task name)"

Specified by:

getSystemComment in interface FlowNodeState

Returns:

system comment "User XYZ has XYZ(state change) task XYZ(task name)"