org.bonitasoft.engine.bpm.flownode.impl.internal

Class FlowNodeInstanceImpl

java.lang.Object

org.bonitasoft.engine.bpm.internal.BaseElementImpl

org.bonitasoft.engine.bpm.internal.NamedElementImpl

org.bonitasoft.engine.bpm.flownode.impl.internal.FlowNodeInstanceImpl

All Implemented Interfaces:

Serializable, BaseElement, BonitaObject, DescriptionElement, FlowNodeInstance, NamedElement

Direct Known Subclasses:

ActivityInstanceImpl, EventInstanceImpl, GatewayInstanceImpl

public abstract class FlowNodeInstanceImpl
extends NamedElementImpl
implements FlowNodeInstance

Author:

Elias Ricken de Medeiros, Baptiste Mesta, Celine Souchet

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FlowNodeInstanceImpl(String name, long flownodeDefinitionId)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription() Gets the element description.
String	getDisplayDescription()
String	getDisplayName()
long	getExecutedBy()
long	getExecutedByDelegate() Deprecated.
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()
int	hashCode()
void	setDescription(String description)
void	setDisplayDescription(String displayDescription)
void	setDisplayName(String displayName)
void	setExecutedBy(long executedBy)
void	setExecutedByDelegate(long executedByDelegate) Deprecated.
void	setExecutedBySubstitute(long executedBySubstitute)
void	setFlownodeDefinitionId(long flownodeDefinitionId)
void	setLastUpdateDate(Date lastUpdateDate)
void	setParentContainerId(long parentContainerId)
void	setParentProcessInstanceId(long parentProcessInstanceId)
void	setProcessDefinitionId(long processDefinitionId)
void	setReachedSateDate(Date reachedStateDate)
void	setRootContainerId(long rootContainerId)
void	setState(String state)
void	setStateCategory(StateCategory stateCategory)
String	toString()

Methods inherited from class org.bonitasoft.engine.bpm.internal.NamedElementImpl

getName, setName

Methods inherited from class org.bonitasoft.engine.bpm.internal.BaseElementImpl

getId, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bonitasoft.engine.bpm.flownode.FlowNodeInstance

getType

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

getName

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

getId

Constructor Detail

FlowNodeInstanceImpl

public FlowNodeInstanceImpl(String name,
                            long flownodeDefinitionId)

Method Detail

getParentContainerId

public long getParentContainerId()

Description copied from interface: FlowNodeInstance

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).

Specified by:

getParentContainerId in interface FlowNodeInstance

Returns:

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

setParentContainerId

public void setParentContainerId(long parentContainerId)

getState

public String getState()

Description copied from interface: FlowNodeInstance

Returns a String representation of this FlowNodeInstance state.

Specified by:

getState in interface FlowNodeInstance

Returns:

this FlowNodeInstance state

setState

public void setState(String state)

getStateCategory

public StateCategory getStateCategory()

Specified by:

getStateCategory in interface FlowNodeInstance

setStateCategory

public void setStateCategory(StateCategory stateCategory)

getRootContainerId

public long getRootContainerId()

Description copied from interface: FlowNodeInstance

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

Specified by:

getRootContainerId in interface FlowNodeInstance

Returns:

the root container ID.

setRootContainerId

public void setRootContainerId(long rootContainerId)

getProcessDefinitionId

public long getProcessDefinitionId()

Description copied from interface: FlowNodeInstance

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

Specified by:

getProcessDefinitionId in interface FlowNodeInstance

Returns:

the ID of the process definition.

setProcessDefinitionId

public void setProcessDefinitionId(long processDefinitionId)

getParentProcessInstanceId

public long getParentProcessInstanceId()

Description copied from interface: FlowNodeInstance

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

Specified by:

getParentProcessInstanceId in interface FlowNodeInstance

Returns:

the ID of the lowest-level containing process instance.

setParentProcessInstanceId

public void setParentProcessInstanceId(long parentProcessInstanceId)

getDisplayDescription

public String getDisplayDescription()

Specified by:

getDisplayDescription in interface FlowNodeInstance

setDisplayDescription

public void setDisplayDescription(String displayDescription)

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface FlowNodeInstance

setDisplayName

public void setDisplayName(String displayName)

getDescription

public String getDescription()

Description copied from interface: DescriptionElement

Gets the element description.

Specified by:

getDescription in interface DescriptionElement

Returns:

the element description

setDescription

public void setDescription(String description)

getExecutedBy

public long getExecutedBy()

Specified by:

getExecutedBy in interface FlowNodeInstance

Returns:

The identifier of the user who executed the flow node

setExecutedBy

public void setExecutedBy(long executedBy)

getExecutedBySubstitute

public long getExecutedBySubstitute()

Specified by:

getExecutedBySubstitute in interface FlowNodeInstance

Returns:

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

setExecutedBySubstitute

public void setExecutedBySubstitute(long executedBySubstitute)

getExecutedByDelegate

@Deprecated
public long getExecutedByDelegate()

Deprecated.

Specified by:

getExecutedByDelegate in interface FlowNodeInstance

Returns:

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

setExecutedByDelegate

@Deprecated
public void setExecutedByDelegate(long executedByDelegate)

Deprecated.

getFlownodeDefinitionId

public long getFlownodeDefinitionId()

Description copied from interface: FlowNodeInstance

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

Specified by:

getFlownodeDefinitionId in interface FlowNodeInstance

Returns:

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

setFlownodeDefinitionId

public void setFlownodeDefinitionId(long flownodeDefinitionId)

getReachedStateDate

public Date getReachedStateDate()

Specified by:

getReachedStateDate in interface FlowNodeInstance

Returns:

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

setReachedSateDate

public void setReachedSateDate(Date reachedStateDate)

getLastUpdateDate

public Date getLastUpdateDate()

Specified by:

getLastUpdateDate in interface FlowNodeInstance

Returns:

The last date when the activity instance was updated

setLastUpdateDate

public void setLastUpdateDate(Date lastUpdateDate)

hashCode

public int hashCode()

Overrides:

hashCode in class NamedElementImpl

equals

public boolean equals(Object o)

Overrides:

equals in class NamedElementImpl

toString

public String toString()

Overrides:

toString in class NamedElementImpl