org.bonitasoft.engine.bpm.flownode

Interface FlowNodeInstance

All Superinterfaces:

BaseElement, BonitaObject, DescriptionElement, NamedElement, Serializable

All Known Subinterfaces:

ActivityInstance, AutomaticTaskInstance, BoundaryEventInstance, CallActivityInstance, CatchEventInstance, EndEventInstance, EventInstance, GatewayInstance, HumanTaskInstance, IntermediateCatchEventInstance, IntermediateThrowEventInstance, LoopActivityInstance, ManualTaskInstance, MultiInstanceActivityInstance, ReceiveTaskInstance, SendTaskInstance, StartEventInstance, SubProcessActivityInstance, TaskInstance, ThrowEventInstance, UserTaskInstance

All Known Implementing Classes:

ActivityInstanceImpl, AutomaticTaskInstanceImpl, BoundaryEventInstanceImpl, CallActivityInstanceImpl, CatchEventInstanceImpl, EndEventInstanceImpl, EventInstanceImpl, FlowNodeInstanceImpl, GatewayInstanceImpl, HumanTaskInstanceImpl, IntermediateCatchEventInstanceImpl, IntermediateThrowEventInstanceImpl, LoopActivityInstanceImpl, ManualTaskInstanceImpl, MultiInstanceActivityInstanceImpl, ReceiveTaskInstanceImpl, SendTaskInstanceImpl, StartEventInstanceImpl, SubProcessActivityInstanceImpl, TaskInstanceImpl, ThrowEventInstanceImpl, UserTaskInstanceImpl

public interface FlowNodeInstance
extends DescriptionElement, BaseElement

Since:

6.0.0

Version:

6.4.1

Author:

Baptiste Mesta, Elias Ricken de Medeiros, Celine Souchet

Method Summary

Modifier and Type	Method and Description
String	getDisplayDescription()
String	getDisplayName()
long	getExecutedBy()
long	getExecutedByDelegate() Deprecated. since 6.3.0, use getExecutedBySubstitute()
long	getExecutedBySubstitute()
long	getFlownodeDefinitionId() Returns the ID of the flow node definition of this instance.
Date	getLastUpdateDate()
long	getParentContainerId() Returns the task's direct container ID.
long	getParentProcessInstanceId() Always returns the directly containing process instance ID (at the lower level, if several levels of containing processes).
long	getProcessDefinitionId() Returns the ID of the process definition where this FlowNodeInstance is defined.
Date	getReachedStateDate()
long	getRootContainerId() Returns the root container ID.
String	getState() Returns a String representation of this FlowNodeInstance state.
StateCategory	getStateCategory()
FlowNodeType	getType() Returns the FlowNodeType that precises the concrete type of this FlowNodeInstance.

Methods inherited from interface org.bonitasoft.engine.bpm.DescriptionElement

getDescription

Methods inherited from interface org.bonitasoft.engine.bpm.NamedElement

getName

Methods inherited from interface org.bonitasoft.engine.bpm.BaseElement

getId

Method Detail

getParentContainerId

long getParentContainerId()

Returns the task's direct container ID. For a sub-task or CallActivity, would point to the containing activity ID of the current element. For a normal Task / Activity, would point to the ID of the process instance containing the task / activity. For a multi-instanciated task, each task has its parentContainerId pointing to the containing multi-instance task (basic container for all task instances).

Returns:

the ID of the direct containing element (activity instance of process instance).

getRootContainerId

long getRootContainerId()

Returns the root container ID. It is the ID of the root-level containing process instance.

Returns:

the root container ID.

getProcessDefinitionId

long getProcessDefinitionId()

Returns the ID of the process definition where this FlowNodeInstance is defined.

Returns:

the ID of the process definition.

getParentProcessInstanceId

long getParentProcessInstanceId()

Always returns the directly containing process instance ID (at the lower level, if several levels of containing processes).

Returns:

the ID of the lowest-level containing process instance.

getState

String getState()

Returns a String representation of this FlowNodeInstance state.

Returns:

this FlowNodeInstance state

getStateCategory

StateCategory getStateCategory()

getType

FlowNodeType getType()

Returns the FlowNodeType that precises the concrete type of this FlowNodeInstance.

Returns:

the FlowNodeType

getDisplayDescription

String getDisplayDescription()

getDisplayName

String getDisplayName()

getExecutedBy

long getExecutedBy()

Returns:

The identifier of the user who executed the flow node

Since:

6.0.1

getExecutedBySubstitute

long getExecutedBySubstitute()

Returns:

The identifier of the substitute user (as Process manager or Administrator) who executed the flow node.

Since:

6.3.0

getExecutedByDelegate

@Deprecated
long getExecutedByDelegate()

Deprecated. since 6.3.0, use getExecutedBySubstitute()

Returns:

The identifier of the substitute user (as Process manager or Administrator) who executed the flow node.

Since:

6.0.1

getFlownodeDefinitionId

long getFlownodeDefinitionId()

Returns the ID of the flow node definition of this instance.

Returns:

the ID of the flow node definition that this FlowNodeInstance is an instance of.

getReachedStateDate

Date getReachedStateDate()

Returns:

The date when the flownode instance reached its state (getState())

getLastUpdateDate

Date getLastUpdateDate()

Returns:

The last date when the activity instance was updated