org.camunda.bpm.engine.history
Interface HistoricProcessInstance

All Known Implementing Classes:

HistoricProcessInstanceEntity

public interface HistoricProcessInstance

A single execution of a whole process definition that is stored permanently.

Author:

Christian Stettler

Method Summary

String	getBusinessKey() The user provided unique reference to this process instance.
String	getCaseInstanceId() The case instance id of a potential super case instance or null if no super case instance exists
String	getDeleteReason() Obtains the reason for the process instance's deletion.
Long	getDurationInMillis() The difference between getEndTime() and getStartTime() .
String	getEndActivityId() Deprecated.
Date	getEndTime() The time the process was ended.
String	getId() The process instance id (== as the id for the runtime process instance).
String	getProcessDefinitionId() The process definition reference.
String	getProcessDefinitionKey() The process definition key reference.
String	getStartActivityId() The start activity.
Date	getStartTime() The time the process was started.
String	getStartUserId() The authenticated user that started this process instance.
String	getSuperCaseInstanceId() The case instance id of a potential super case instance or null if no super case instance exists
String	getSuperProcessInstanceId() The process instance id of a potential super process instance or null if no super process instance exists

Method Detail

getId

String getId()

The process instance id (== as the id for the runtime process instance).

getBusinessKey

String getBusinessKey()

The user provided unique reference to this process instance.

getProcessDefinitionKey

String getProcessDefinitionKey()

The process definition key reference.

getProcessDefinitionId

String getProcessDefinitionId()

The process definition reference.

getStartTime

Date getStartTime()

The time the process was started.

getEndTime

Date getEndTime()

The time the process was ended.

getDurationInMillis

Long getDurationInMillis()

The difference between getEndTime() and getStartTime() .

getEndActivityId

@Deprecated
String getEndActivityId()

Deprecated.

Reference to the activity in which this process instance ended. Note that a process instance can have multiple end events, in this case it might not be deterministic which activity id will be referenced here. Use a HistoricActivityInstanceQuery instead to query for end events of the process instance (use the activityTYpe attribute)

getStartUserId

String getStartUserId()

The authenticated user that started this process instance.

See Also:

IdentityService.setAuthenticatedUserId(String)

getStartActivityId

String getStartActivityId()

The start activity.

getDeleteReason

String getDeleteReason()

Obtains the reason for the process instance's deletion.

getSuperProcessInstanceId

String getSuperProcessInstanceId()

The process instance id of a potential super process instance or null if no super process instance exists

getSuperCaseInstanceId

String getSuperCaseInstanceId()

The case instance id of a potential super case instance or null if no super case instance exists

getCaseInstanceId

String getCaseInstanceId()

The case instance id of a potential super case instance or null if no super case instance exists