org.bonitasoft.engine.bpm.process

Interface ProcessInstance

All Superinterfaces:

BaseElement, BonitaObject, NamedElement, Serializable

All Known Implementing Classes:

ProcessInstanceImpl

public interface ProcessInstance
extends NamedElement, BaseElement

Represents a running instance of a process. Gives access to the information of the instance, whereas the state, the definition of the process instance...

Since:

6.0.0

Version:

6.3.5

Author:

Baptiste Mesta, Matthieu Chaffotte, Celine Souchet

Method Summary

Modifier and Type	Method and Description
long	getCallerId() Get the identifier of the flow node instance who starts this process instance.
String	getDescription() Get the description of this process instance.
Date	getEndDate() Get the date when this process instance was finished.
Date	getLastUpdate() Get the date of the last update of this process instance.
long	getProcessDefinitionId() Get the identifier of the definition of this process.
long	getRootProcessInstanceId() Get the identifier of the root ProcessInstance of this process instance.
Date	getStartDate() Get the date when this process instance was started.
long	getStartedBy() Get the identifier of the user who started this process instance.
long	getStartedByDelegate() Deprecated. since 6.3.0, use getStartedBySubstitute()
long	getStartedBySubstitute() Get the identifier of the substitute user (as Process manager or Administrator) who started this process instance.
String	getState() Get the state of this process instance.
String	getStringIndex1() This field is used to extend the meta data of the process instance.
String	getStringIndex2() This field is used to extend the meta data of the process instance.
String	getStringIndex3() This field is used to extend the meta data of the process instance.
String	getStringIndex4() This field is used to extend the meta data of the process instance.
String	getStringIndex5() This field is used to extend the meta data of the process instance.
String	getStringIndexLabel(int index) The index must be between 1 and 5.

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

getName

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

getId

Method Detail

getState

String getState()

Get the state of this process instance.

Returns:

The current state of this process instance.

Since:

6.0.0

See Also:

ProcessInstanceState

getStartDate

Date getStartDate()

Get the date when this process instance was started.

Returns:

The date when this process instance was started.

Since:

6.0.0

getStartedBy

long getStartedBy()

Get the identifier of the user who started this process instance.

Returns:

The identifier of the user who started this process instance.

Since:

6.0.0

getStartedBySubstitute

long getStartedBySubstitute()

Get the identifier of the substitute user (as Process manager or Administrator) who started this process instance.

Returns:

The identifier of the substitute user (as Process manager or Administrator) who started this process instance.

Since:

6.3.0

getStartedByDelegate

@Deprecated
long getStartedByDelegate()

Deprecated. since 6.3.0, use getStartedBySubstitute()

Get the identifier of the substitute user (as Process manager or Administrator) who started this process instance.

Returns:

The identifier of the substitute user (as Process manager or Administrator) who started this process instance.

Since:

6.0.1

getEndDate

Date getEndDate()

Get the date when this process instance was finished. It equals to null, if this process instance is not finished.

Returns:

The date when this process instance was finished.

Since:

6.0.0

getLastUpdate

Date getLastUpdate()

Get the date of the last update of this process instance.

Returns:

The date of the last update of this process instance.

Since:

6.0.0

getProcessDefinitionId

long getProcessDefinitionId()

Get the identifier of the definition of this process.

Returns:

The identifier of the definition of this process.

Since:

6.0.0

See Also:

BaseElement.getId()

getDescription

String getDescription()

Get the description of this process instance.

Returns:

The description of this process instance.

Since:

6.0.0

getRootProcessInstanceId

long getRootProcessInstanceId()

Get the identifier of the root ProcessInstance of this process instance. Is -1 if this process instance is not a child of another process instance.

Returns:

The identifier of the root process instance of this process instance.

Since:

6.0.0

See Also:

BaseElement.getId(), ArchivedElement.getSourceObjectId()

getCallerId

long getCallerId()

Get the identifier of the flow node instance who starts this process instance. Is -1 if this process instance is not a child of another process instance.

Returns:

The identifier of the flow node instance who starts this process instance.

Since:

6.0.0

See Also:

BaseElement.getId(), BaseElement.getId()

getStringIndex1

String getStringIndex1()

This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no first string index.

Returns:

The first string index of this process instance.

Since:

6.0.0

See Also:

getStringIndexLabel(int)

getStringIndex2

String getStringIndex2()

This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no second string index.

Returns:

The second string index of this process instance.

Since:

6.0.0

See Also:

getStringIndexLabel(int)

getStringIndex3

String getStringIndex3()

This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no third string index.

Returns:

The third string index of this process instance.

Since:

6.0.0

See Also:

getStringIndexLabel(int)

getStringIndex4

String getStringIndex4()

This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no fourth string index.

Returns:

The fourth string index of this process instance.

Since:

6.0.0

See Also:

getStringIndexLabel(int)

getStringIndex5

String getStringIndex5()

This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no fifth string index.

Returns:

The fifth string index of this process instance.

Since:

6.0.0

See Also:

getStringIndexLabel(int)

getStringIndexLabel

String getStringIndexLabel(int index)

The index must be between 1 and 5.

Parameters:

index - The index of the label

Returns:

The label of the string index corresponding to the parameter

Throws:

IndexOutOfBoundsException - It's thrown if the parameter is not between 1 and 5.

Since:

6.0.0