org.camunda.bpm.engine.history

Interface HistoricActivityInstance

All Known Implementing Classes:

HistoricActivityInstanceEntity

public interface HistoricActivityInstance

Represents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.

Author:

Christian Stettler

Method Summary

Modifier and Type	Method and Description
String	getActivityId() The unique identifier of the activity in the process
String	getActivityName() The display name for the activity
String	getActivityType() The activity type of the activity.
String	getAssignee() Assignee in case of user task activity
String	getCalledCaseInstanceId() The called case instance in case of (case) call activity
String	getCalledProcessInstanceId() The called process instance in case of call activity
Long	getDurationInMillis() Difference between getEndTime() and getStartTime().
Date	getEndTime() Time when the activity instance ended
String	getExecutionId() Execution reference
String	getId() The unique identifier of this historic activity instance.
String	getParentActivityInstanceId() return the id of the parent activity instance
String	getProcessDefinitionId() Process definition reference
String	getProcessDefinitionKey() Process definition key reference
String	getProcessInstanceId() Process instance reference
Date	getRemovalTime() The time the historic activity instance will be removed.
String	getRootProcessInstanceId() Root process instance reference
Date	getStartTime() Time when the activity instance started
String	getTaskId() The corresponding task in case of task activity
String	getTenantId() The id of the tenant this historic activity instance belongs to.
boolean	isCanceled() Was this activity instance canceled
boolean	isCompleteScope() Did this activity instance complete a BPMN 2.0 scope

Method Detail

getId

String getId()

The unique identifier of this historic activity instance.

getParentActivityInstanceId

String getParentActivityInstanceId()

return the id of the parent activity instance

getActivityId

String getActivityId()

The unique identifier of the activity in the process

getActivityName

String getActivityName()

The display name for the activity

getActivityType

String getActivityType()

The activity type of the activity. Typically the activity type correspond to the XML tag used in the BPMN 2.0 process definition file. All activity types are available in ActivityTypes

See Also:

ActivityTypes

getProcessDefinitionKey

String getProcessDefinitionKey()

Process definition key reference

getProcessDefinitionId

String getProcessDefinitionId()

Process definition reference

getRootProcessInstanceId

String getRootProcessInstanceId()

Root process instance reference

getProcessInstanceId

String getProcessInstanceId()

Process instance reference

getExecutionId

String getExecutionId()

Execution reference

getTaskId

String getTaskId()

The corresponding task in case of task activity

getCalledProcessInstanceId

String getCalledProcessInstanceId()

The called process instance in case of call activity

getCalledCaseInstanceId

String getCalledCaseInstanceId()

The called case instance in case of (case) call activity

getAssignee

String getAssignee()

Assignee in case of user task activity

getStartTime

Date getStartTime()

Time when the activity instance started

getEndTime

Date getEndTime()

Time when the activity instance ended

getDurationInMillis

Long getDurationInMillis()

Difference between getEndTime() and getStartTime().

isCompleteScope

boolean isCompleteScope()

Did this activity instance complete a BPMN 2.0 scope

isCanceled

boolean isCanceled()

Was this activity instance canceled

getTenantId

String getTenantId()

The id of the tenant this historic activity instance belongs to. Can be null if the historic activity instance belongs to no single tenant.

getRemovalTime

Date getRemovalTime()

The time the historic activity instance will be removed.