Package 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 TypeMethodDescriptionThe unique identifier of the activity in the processThe display name for the activityThe activity type of the activity.Assignee in case of user task activityThe called case instance in case of (case) call activityThe called process instance in case of call activityDifference betweengetEndTime()
andgetStartTime()
.Time when the activity instance endedExecution referencegetId()
The unique identifier of this historic activity instance.return the id of the parent activity instanceProcess definition referenceProcess definition key referenceProcess instance referenceThe time the historic activity instance will be removed.Root process instance referenceTime when the activity instance startedThe corresponding task in case of task activityThe id of the tenant this historic activity instance belongs to.boolean
Was this activity instance canceledboolean
Did this activity instance complete a BPMN 2.0 scope
-
Method Details
-
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 inActivityTypes
- See Also:
-
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 betweengetEndTime()
andgetStartTime()
. -
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 benull
if the historic activity instance belongs to no single tenant. -
getRemovalTime
Date getRemovalTime()The time the historic activity instance will be removed.
-