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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getActivityId()
The unique identifier of the activity in the processjava.lang.String
getActivityName()
The display name for the activityjava.lang.String
getActivityType()
The activity type of the activity.java.lang.String
getAssignee()
Assignee in case of user task activityjava.lang.String
getCalledCaseInstanceId()
The called case instance in case of (case) call activityjava.lang.String
getCalledProcessInstanceId()
The called process instance in case of call activityjava.lang.Long
getDurationInMillis()
Difference betweengetEndTime()
andgetStartTime()
.java.util.Date
getEndTime()
Time when the activity instance endedjava.lang.String
getExecutionId()
Execution referencejava.lang.String
getId()
The unique identifier of this historic activity instance.java.lang.String
getParentActivityInstanceId()
return the id of the parent activity instancejava.lang.String
getProcessDefinitionId()
Process definition referencejava.lang.String
getProcessDefinitionKey()
Process definition key referencejava.lang.String
getProcessInstanceId()
Process instance referencejava.util.Date
getRemovalTime()
The time the historic activity instance will be removed.java.lang.String
getRootProcessInstanceId()
Root process instance referencejava.util.Date
getStartTime()
Time when the activity instance startedjava.lang.String
getTaskId()
The corresponding task in case of task activityjava.lang.String
getTenantId()
The id of the tenant this historic activity instance belongs to.boolean
isCanceled()
Was this activity instance canceledboolean
isCompleteScope()
Did this activity instance complete a BPMN 2.0 scope
-
-
-
Method Detail
-
getId
java.lang.String getId()
The unique identifier of this historic activity instance.
-
getParentActivityInstanceId
java.lang.String getParentActivityInstanceId()
return the id of the parent activity instance
-
getActivityId
java.lang.String getActivityId()
The unique identifier of the activity in the process
-
getActivityName
java.lang.String getActivityName()
The display name for the activity
-
getActivityType
java.lang.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:
ActivityTypes
-
getProcessDefinitionKey
java.lang.String getProcessDefinitionKey()
Process definition key reference
-
getProcessDefinitionId
java.lang.String getProcessDefinitionId()
Process definition reference
-
getRootProcessInstanceId
java.lang.String getRootProcessInstanceId()
Root process instance reference
-
getProcessInstanceId
java.lang.String getProcessInstanceId()
Process instance reference
-
getExecutionId
java.lang.String getExecutionId()
Execution reference
-
getTaskId
java.lang.String getTaskId()
The corresponding task in case of task activity
-
getCalledProcessInstanceId
java.lang.String getCalledProcessInstanceId()
The called process instance in case of call activity
-
getCalledCaseInstanceId
java.lang.String getCalledCaseInstanceId()
The called case instance in case of (case) call activity
-
getAssignee
java.lang.String getAssignee()
Assignee in case of user task activity
-
getStartTime
java.util.Date getStartTime()
Time when the activity instance started
-
getEndTime
java.util.Date getEndTime()
Time when the activity instance ended
-
getDurationInMillis
java.lang.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
java.lang.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
java.util.Date getRemovalTime()
The time the historic activity instance will be removed.
-
-