Package org.flowable.cmmn.engine.impl.runtime

Class PlanItemInstanceTransitionBuilderImpl

java.lang.Object

org.flowable.cmmn.engine.impl.runtime.PlanItemInstanceTransitionBuilderImpl

All Implemented Interfaces:

PlanItemInstanceTransitionBuilder

public class PlanItemInstanceTransitionBuilderImpl
extends Object
implements PlanItemInstanceTransitionBuilder

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected FormInfo	childTaskFormInfo
protected String	childTaskFormOutcome
protected Map<String,Object>	childTaskFormVariables
protected Map<String,Object>	childTaskVariables
protected CommandExecutor	commandExecutor
protected FormInfo	formInfo
protected String	formOutcome
protected Map<String,Object>	formVariables
protected Map<String,Object>	localVariables
protected String	planItemInstanceId
protected Map<String,Object>	transientVariables
protected Map<String,Object>	variables

Constructor Summary

Constructors

Constructor	Description
PlanItemInstanceTransitionBuilderImpl(CommandExecutor commandExecutor, String planItemInstanceId)

Method Summary

Modifier and Type	Method	Description
PlanItemInstanceTransitionBuilder	childTaskFormVariables(Map<String,Object> variables, FormInfo formInfo, String outcome)	The form variables that should be used when creating a new 'child entity'.
PlanItemInstanceTransitionBuilder	childTaskVariable(String variableName, Object variableValue)	Behaviors that create a new 'child entity' can take in specialized variables.
PlanItemInstanceTransitionBuilder	childTaskVariables(Map<String,Object> childTaskVariables)	See PlanItemInstanceTransitionBuilder.childTaskVariable(String, Object).
void	completeStage()	Completes the plan item instance, which needs to be a stage instance.
void	disable()	Disables a manually activated plan item instance.
void	enable()	Enables a manually activated plan item instance.
void	forceCompleteStage()	Completes the plan item instance, which needs to be a stage instance.
PlanItemInstanceTransitionBuilder	formVariables(Map<String,Object> variables, FormInfo formInfo, String outcome)	The form variables that should be set before the transition is executed.
PlanItemInstanceTransitionBuilder	localVariable(String variableName, Object variableValue)	Sets a local variable before the transition is executed.
PlanItemInstanceTransitionBuilder	localVariables(Map<String,Object> localVariables)	See PlanItemInstanceTransitionBuilder.localVariable(String, Object).
void	start()	Starts a plan item instance, this typically will executes it associated behavior.
void	terminate()	Manually terminates a plan item instance.
PlanItemInstanceTransitionBuilder	transientVariable(String variableName, Object variableValue)	Sets a non-persisted variable before the transition is executed.
PlanItemInstanceTransitionBuilder	transientVariables(Map<String,Object> transientVariables)	See PlanItemInstanceTransitionBuilder.transientVariable(String, Object).
void	trigger()	Triggers a plan item to continue, e.g.
protected void	validateChildTaskVariablesNotSet()
PlanItemInstanceTransitionBuilder	variable(String variableName, Object variableValue)	Sets a variable before the transition is executed.
PlanItemInstanceTransitionBuilder	variables(Map<String,Object> variables)	See PlanItemInstanceTransitionBuilder.variable(String, Object).

Methods inherited from class java.lang.Object

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

Field Details

commandExecutor

protected CommandExecutor commandExecutor

planItemInstanceId

protected String planItemInstanceId

variables

protected Map<String,Object> variables

formVariables

protected Map<String,Object> formVariables

formOutcome

protected String formOutcome

formInfo

protected FormInfo formInfo

localVariables

protected Map<String,Object> localVariables

transientVariables

protected Map<String,Object> transientVariables

childTaskVariables

protected Map<String,Object> childTaskVariables

childTaskFormVariables

protected Map<String,Object> childTaskFormVariables

childTaskFormOutcome

protected String childTaskFormOutcome

childTaskFormInfo

protected FormInfo childTaskFormInfo

Constructor Details

PlanItemInstanceTransitionBuilderImpl

public PlanItemInstanceTransitionBuilderImpl(CommandExecutor commandExecutor,
 String planItemInstanceId)

Method Details

variable

public PlanItemInstanceTransitionBuilder variable(String variableName,
 Object variableValue)

Description copied from interface: PlanItemInstanceTransitionBuilder

Sets a variable before the transition is executed. The variable will be stored on the case instance.

Specified by:

variable in interface PlanItemInstanceTransitionBuilder

variables

public PlanItemInstanceTransitionBuilder variables(Map<String,Object> variables)

Description copied from interface: PlanItemInstanceTransitionBuilder

See PlanItemInstanceTransitionBuilder.variable(String, Object).

Specified by:

variables in interface PlanItemInstanceTransitionBuilder

formVariables

public PlanItemInstanceTransitionBuilder formVariables(Map<String,Object> variables,
 FormInfo formInfo,
 String outcome)

Description copied from interface: PlanItemInstanceTransitionBuilder

The form variables that should be set before the transition is executed.

Specified by:

formVariables in interface PlanItemInstanceTransitionBuilder

localVariable

public PlanItemInstanceTransitionBuilder localVariable(String variableName,
 Object variableValue)

Description copied from interface: PlanItemInstanceTransitionBuilder

Sets a local variable before the transition is executed. The variable will be stored locally on the plan item instance.

Specified by:

localVariable in interface PlanItemInstanceTransitionBuilder

localVariables

public PlanItemInstanceTransitionBuilder localVariables(Map<String,Object> localVariables)

Description copied from interface: PlanItemInstanceTransitionBuilder

See PlanItemInstanceTransitionBuilder.localVariable(String, Object).

Specified by:

localVariables in interface PlanItemInstanceTransitionBuilder

transientVariable

public PlanItemInstanceTransitionBuilder transientVariable(String variableName,
 Object variableValue)

Description copied from interface: PlanItemInstanceTransitionBuilder

Sets a non-persisted variable before the transition is executed. The transient variable will not be persisted at the end of the database transaction.

Specified by:

transientVariable in interface PlanItemInstanceTransitionBuilder

transientVariables

public PlanItemInstanceTransitionBuilder transientVariables(Map<String,Object> transientVariables)

Description copied from interface: PlanItemInstanceTransitionBuilder

See PlanItemInstanceTransitionBuilder.transientVariable(String, Object).

Specified by:

transientVariables in interface PlanItemInstanceTransitionBuilder

childTaskVariable

public PlanItemInstanceTransitionBuilder childTaskVariable(String variableName,
 Object variableValue)

Description copied from interface: PlanItemInstanceTransitionBuilder

Behaviors that create a new 'child entity' can take in specialized variables. For example: the case task can pass variables that will be set on the child case instance and not on the parent case instance. Only allowed when starting a plan item instance.

Specified by:

childTaskVariable in interface PlanItemInstanceTransitionBuilder

childTaskVariables

public PlanItemInstanceTransitionBuilder childTaskVariables(Map<String,Object> childTaskVariables)

Description copied from interface: PlanItemInstanceTransitionBuilder

See PlanItemInstanceTransitionBuilder.childTaskVariable(String, Object).

Specified by:

childTaskVariables in interface PlanItemInstanceTransitionBuilder

childTaskFormVariables

public PlanItemInstanceTransitionBuilder childTaskFormVariables(Map<String,Object> variables,
 FormInfo formInfo,
 String outcome)

Description copied from interface: PlanItemInstanceTransitionBuilder

The form variables that should be used when creating a new 'child entity'.

Specified by:

childTaskFormVariables in interface PlanItemInstanceTransitionBuilder

See Also:

• PlanItemInstanceTransitionBuilder.childTaskVariable(String, Object)

trigger

public void trigger()

Description copied from interface: PlanItemInstanceTransitionBuilder

Triggers a plan item to continue, e.g. a human task completion, a service task wait state that continues, etc.

Specified by:

trigger in interface PlanItemInstanceTransitionBuilder

enable

public void enable()

Description copied from interface: PlanItemInstanceTransitionBuilder

Enables a manually activated plan item instance.

Specified by:

enable in interface PlanItemInstanceTransitionBuilder

disable

public void disable()

Description copied from interface: PlanItemInstanceTransitionBuilder

Disables a manually activated plan item instance.

Specified by:

disable in interface PlanItemInstanceTransitionBuilder

start

public void start()

Description copied from interface: PlanItemInstanceTransitionBuilder

Starts a plan item instance, this typically will executes it associated behavior.

Specified by:

start in interface PlanItemInstanceTransitionBuilder

terminate

public void terminate()

Description copied from interface: PlanItemInstanceTransitionBuilder

Manually terminates a plan item instance.

Specified by:

terminate in interface PlanItemInstanceTransitionBuilder

completeStage

public void completeStage()

Description copied from interface: PlanItemInstanceTransitionBuilder

Completes the plan item instance, which needs to be a stage instance. The stage needs to be completable, otherwise an exception will be thrown.

Specified by:

completeStage in interface PlanItemInstanceTransitionBuilder

forceCompleteStage

public void forceCompleteStage()

Description copied from interface: PlanItemInstanceTransitionBuilder

Completes the plan item instance, which needs to be a stage instance. The stage is completed, irregardless whether it is completable or not.

Specified by:

forceCompleteStage in interface PlanItemInstanceTransitionBuilder

validateChildTaskVariablesNotSet

protected void validateChildTaskVariablesNotSet()