org.bonitasoft.engine.bpm.process

Interface ArchivedProcessInstance

All Superinterfaces:

ArchivedElement, BaseElement, BonitaObject, NamedElement, Serializable

All Known Implementing Classes:

ArchivedProcessInstanceImpl

public interface ArchivedProcessInstance
extends NamedElement, BaseElement, ArchivedElement

Represents an archived instance of a process. Gives access to the information of the instance, whereas the state, the definition, the archived date of the process instance...

Since:

6.0.0

Version:

6.3.5

Author:

Baptiste Mesta, Elias Ricken de Medeiros, 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, when the process instance was archived.
Date	getEndDate() Get the date when this process instance was finished.
Date	getLastUpdate() Get the date of the last update of this process instance, when the process instance was archived.
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. As of version 6.3.0, replaced by 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 when it was archived.
int	getStateId() Get the identifier of the state of this process instance when it was archived.
String	getStringIndexLabel(int index) The index must be between 1 and 5.
String	getStringIndexValue(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

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

getArchiveDate, getSourceObjectId

Method Detail

getState

String getState()

Get the state of this process instance when it was archived.

Returns:

The state of this process instance when it was archived.

Since:

6.0.0

See Also:

ProcessInstanceState

getStateId

int getStateId()

Get the identifier of the state of this process instance when it was archived.

Returns:

The identifier of the state of this process instance when it was archived.

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. As of version 6.3.0, replaced by 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, when the process instance was archived.

Returns:

The date of the last update of this process instance, when the process instance was archived.

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, when the process instance was archived.

Returns:

The description of this process instance, when the process instance was archived.

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 ProcessInstance 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()

getStringIndexValue

String getStringIndexValue(int index)

The index must be between 1 and 5.

Parameters:

index - The index of the value

Returns:

The value of the string index corresponding to the parameter

Throws:

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

Since:

6.4.0

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