org.bonitasoft.engine.core.process.instance.model

Interface SProcessInstance

All Superinterfaces:

PersistentObject, Serializable, SFlowElementsContainer, SNamedElement

All Known Implementing Classes:

SProcessInstanceImpl

public interface SProcessInstance
extends SFlowElementsContainer

Author:

Elias Ricken de Medeiros, Yanyan Liu, Matthieu Chaffotte, Baptiste Mesta, Celine Souchet

Method Summary

Modifier and Type	Method and Description
long	getCallerId() Get the id of the call activity that started the process instance.
SFlowNodeType	getCallerType() Get the caller's SFlowNodeType.
long	getContainerId() Deprecated.
String	getDescription()
long	getEndDate()
long	getInterruptingEventId() Get the id of the end error event that interrupted the process instance.
long	getLastUpdate()
long	getProcessDefinitionId()
long	getRootProcessInstanceId()
long	getStartDate()
long	getStartedBy()
long	getStartedBySubstitute()
SStateCategory	getStateCategory()
int	getStateId()
String	getStringIndex1()
String	getStringIndex2()
String	getStringIndex3()
String	getStringIndex4()
String	getStringIndex5()
boolean	hasBeenInterruptedByEvent()
boolean	isRootInstance() Determines if this instance is a root process instance.

Methods inherited from interface org.bonitasoft.engine.core.process.instance.model.SFlowElementsContainer

getContainerType

Methods inherited from interface org.bonitasoft.engine.core.process.instance.model.SNamedElement

getName, setName

Methods inherited from interface org.bonitasoft.engine.persistence.PersistentObject

getDiscriminator, getId, setId, setTenantId

Method Detail

getProcessDefinitionId

long getProcessDefinitionId()

getDescription

String getDescription()

getStateId

int getStateId()

getStartDate

long getStartDate()

getStartedBy

long getStartedBy()

Returns:

id of the user who originally started the process

Since:

6.0.1

getStartedBySubstitute

long getStartedBySubstitute()

Returns:

id of the user (delegate) who started the process for the original starter

Since:

6.0.1

getEndDate

long getEndDate()

getLastUpdate

long getLastUpdate()

getContainerId

@Deprecated
long getContainerId()

Deprecated.

getRootProcessInstanceId

long getRootProcessInstanceId()

getCallerId

long getCallerId()

Get the id of the call activity that started the process instance.

Returns:

id of the call activity that started the process instance or -1 if the process instance was not started by a call activity

getCallerType

SFlowNodeType getCallerType()

Get the caller's SFlowNodeType.

Returns:

the caller's SFlowNodeType if the it's called by a call activity or sub-process, null otherwise

getInterruptingEventId

long getInterruptingEventId()

Get the id of the end error event that interrupted the process instance.

Returns:

the id of the end error event that interrupted the process instance or -1 if the process was not interrupted by a end error event

getStateCategory

SStateCategory getStateCategory()

getStringIndex1

String getStringIndex1()

getStringIndex2

String getStringIndex2()

getStringIndex3

String getStringIndex3()

getStringIndex4

String getStringIndex4()

getStringIndex5

String getStringIndex5()

hasBeenInterruptedByEvent

boolean hasBeenInterruptedByEvent()

isRootInstance

boolean isRootInstance()

Determines if this instance is a root process instance. That is, it is neither a process called by a call activity, neither a sub-process

Returns:

true if it's a root process instance; false otherwise.