Package org.flowable.engine.impl.delegate

Class ReadOnlyDelegateExecutionImpl

java.lang.Object

org.flowable.engine.impl.delegate.ReadOnlyDelegateExecutionImpl

All Implemented Interfaces:

VariableContainer, ReadOnlyDelegateExecution

public class ReadOnlyDelegateExecutionImpl
extends Object
implements ReadOnlyDelegateExecution

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	active
protected final boolean	concurrent
protected final String	currentActivityId
protected final FlowElement	currentFlowElement
protected final boolean	ended
protected final String	eventName
protected final String	id
protected final boolean	multiInstanceRoot
protected final String	parentId
protected final String	processDefinitionId
protected final String	processInstanceBusinessKey
protected final String	processInstanceBusinessStatus
protected final String	processInstanceId
protected final boolean	processInstanceType
protected final String	propagatedStageInstanceId
protected final String	rootProcessInstanceId
protected final boolean	scope
protected final String	superExecutionId
protected final String	tenantId
protected final Map<String,Object>	variables

Constructor Summary

Constructors

Constructor	Description
ReadOnlyDelegateExecutionImpl(DelegateExecution execution)

Method Summary

Modifier and Type	Method	Description
String	getCurrentActivityId()	Gets the id of the current activity.
FlowElement	getCurrentFlowElement()	The BPMN element where the execution currently is at.
String	getEventName()	Will contain the event name in case this execution is passed in for an ExecutionListener.
String	getId()	Unique id of this path of execution that can be used as a handle to provide external signals back into the engine after wait states.
String	getParentId()	Gets the id of the parent of this execution.
String	getProcessDefinitionId()	The process definition key for the process instance this execution is associated with.
String	getProcessInstanceBusinessKey()	The business key for the process instance this execution is associated with.
String	getProcessInstanceBusinessStatus()	The business status for the process instance this execution is associated with.
String	getProcessInstanceId()	Reference to the overall process instance
String	getPropagatedStageInstanceId()	If this execution runs in the context of a case and stage, this method returns it's closest parent stage instance id (the stage plan item instance id to be precise).
String	getRootProcessInstanceId()	The 'root' process instance.
String	getSuperExecutionId()	Gets the id of the calling execution.
String	getTenantId()
Object	getVariable(String variableName)
boolean	hasVariable(String variableName)
boolean	isActive()	returns whether this execution is currently active.
boolean	isConcurrent()	returns whether this execution is concurrent or not.
boolean	isEnded()	returns whether this execution has ended or not.
boolean	isMultiInstanceRoot()	Returns whether this execution is the root of a multi instance execution.
boolean	isProcessInstanceType()	returns whether this execution is a process instance or not.
boolean	isScope()	Returns whether this execution is a scope.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.engine.delegate.ReadOnlyDelegateExecution

setTransientVariable, setVariable

Field Details

id

protected final String id

processInstanceId

protected final String processInstanceId

rootProcessInstanceId

protected final String rootProcessInstanceId

eventName

protected final String eventName

processInstanceBusinessKey

protected final String processInstanceBusinessKey

processInstanceBusinessStatus

protected final String processInstanceBusinessStatus

processDefinitionId

protected final String processDefinitionId

propagatedStageInstanceId

protected final String propagatedStageInstanceId

parentId

protected final String parentId

superExecutionId

protected final String superExecutionId

currentActivityId

protected final String currentActivityId

tenantId

protected final String tenantId

currentFlowElement

protected final FlowElement currentFlowElement

active

protected final boolean active

ended

protected final boolean ended

concurrent

protected final boolean concurrent

processInstanceType

protected final boolean processInstanceType

scope

protected final boolean scope

multiInstanceRoot

protected final boolean multiInstanceRoot

variables

protected final Map<String,Object> variables

Constructor Details

ReadOnlyDelegateExecutionImpl

public ReadOnlyDelegateExecutionImpl(DelegateExecution execution)

Method Details

getId

public String getId()

Description copied from interface: ReadOnlyDelegateExecution

Unique id of this path of execution that can be used as a handle to provide external signals back into the engine after wait states.

Specified by:

getId in interface ReadOnlyDelegateExecution

getProcessInstanceId

public String getProcessInstanceId()

Description copied from interface: ReadOnlyDelegateExecution

Reference to the overall process instance

Specified by:

getProcessInstanceId in interface ReadOnlyDelegateExecution

getRootProcessInstanceId

public String getRootProcessInstanceId()

Description copied from interface: ReadOnlyDelegateExecution

The 'root' process instance. When using call activity for example, the processInstance set will not always be the root. This method returns the topmost process instance.

Specified by:

getRootProcessInstanceId in interface ReadOnlyDelegateExecution

getEventName

public String getEventName()

Description copied from interface: ReadOnlyDelegateExecution

Will contain the event name in case this execution is passed in for an ExecutionListener.

Specified by:

getEventName in interface ReadOnlyDelegateExecution

getProcessInstanceBusinessKey

public String getProcessInstanceBusinessKey()

Description copied from interface: ReadOnlyDelegateExecution

The business key for the process instance this execution is associated with.

Specified by:

getProcessInstanceBusinessKey in interface ReadOnlyDelegateExecution

getProcessInstanceBusinessStatus

public String getProcessInstanceBusinessStatus()

Description copied from interface: ReadOnlyDelegateExecution

The business status for the process instance this execution is associated with.

Specified by:

getProcessInstanceBusinessStatus in interface ReadOnlyDelegateExecution

getProcessDefinitionId

public String getProcessDefinitionId()

Description copied from interface: ReadOnlyDelegateExecution

The process definition key for the process instance this execution is associated with.

Specified by:

getProcessDefinitionId in interface ReadOnlyDelegateExecution

getPropagatedStageInstanceId

public String getPropagatedStageInstanceId()

Description copied from interface: ReadOnlyDelegateExecution

If this execution runs in the context of a case and stage, this method returns it's closest parent stage instance id (the stage plan item instance id to be precise).

Specified by:

getPropagatedStageInstanceId in interface ReadOnlyDelegateExecution

Returns:

the stage instance id this execution belongs to or null, if this execution is not part of a case at all or is not a child element of a stage

getParentId

public String getParentId()

Description copied from interface: ReadOnlyDelegateExecution

Gets the id of the parent of this execution. If null, the execution represents a process-instance.

Specified by:

getParentId in interface ReadOnlyDelegateExecution

getSuperExecutionId

public String getSuperExecutionId()

Description copied from interface: ReadOnlyDelegateExecution

Gets the id of the calling execution. If not null, the execution is part of a subprocess.

Specified by:

getSuperExecutionId in interface ReadOnlyDelegateExecution

getCurrentActivityId

public String getCurrentActivityId()

Description copied from interface: ReadOnlyDelegateExecution

Gets the id of the current activity.

Specified by:

getCurrentActivityId in interface ReadOnlyDelegateExecution

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface VariableContainer

getCurrentFlowElement

public FlowElement getCurrentFlowElement()

Description copied from interface: ReadOnlyDelegateExecution

The BPMN element where the execution currently is at.

Specified by:

getCurrentFlowElement in interface ReadOnlyDelegateExecution

isActive

public boolean isActive()

Description copied from interface: ReadOnlyDelegateExecution

returns whether this execution is currently active.

Specified by:

isActive in interface ReadOnlyDelegateExecution

isEnded

public boolean isEnded()

Description copied from interface: ReadOnlyDelegateExecution

returns whether this execution has ended or not.

Specified by:

isEnded in interface ReadOnlyDelegateExecution

isConcurrent

public boolean isConcurrent()

Description copied from interface: ReadOnlyDelegateExecution

returns whether this execution is concurrent or not.

Specified by:

isConcurrent in interface ReadOnlyDelegateExecution

isProcessInstanceType

public boolean isProcessInstanceType()

Description copied from interface: ReadOnlyDelegateExecution

returns whether this execution is a process instance or not.

Specified by:

isProcessInstanceType in interface ReadOnlyDelegateExecution

isScope

public boolean isScope()

Description copied from interface: ReadOnlyDelegateExecution

Returns whether this execution is a scope.

Specified by:

isScope in interface ReadOnlyDelegateExecution

isMultiInstanceRoot

public boolean isMultiInstanceRoot()

Description copied from interface: ReadOnlyDelegateExecution

Returns whether this execution is the root of a multi instance execution.

Specified by:

isMultiInstanceRoot in interface ReadOnlyDelegateExecution

getVariable

public Object getVariable(String variableName)

Specified by:

getVariable in interface VariableContainer

hasVariable

public boolean hasVariable(String variableName)

Specified by:

hasVariable in interface VariableContainer

toString

public String toString()

Overrides:

toString in class Object