org.camunda.bpm.engine.history
Interface HistoricCaseActivityInstance

All Known Implementing Classes:

HistoricCaseActivityInstanceEntity

public interface HistoricCaseActivityInstance

Represents one execution of a case activity which is stored permanent for statistics, audit and other business intelligence purposes.

Author:

Sebastian Menski

Method Summary

String	getCalledCaseInstanceId() The corresponding case in case of a case task activity.
String	getCalledProcessInstanceId() The corresponding process in case of a process task activity.
String	getCaseActivityId() The unique identifier of the case activity in the case.
String	getCaseActivityName() The display name for the case activity.
String	getCaseActivityType() The display type for the case activity.
String	getCaseDefinitionId() The case definition reference.
String	getCaseExecutionId() The case execution reference.
String	getCaseInstanceId() The case instance reference.
Date	getCreateTime() The time when the case activity was created.
Long	getDurationInMillis() Difference between getEndTime() and getCreateTime().
Date	getEndTime() The time when the case activity ended
String	getId() The id of the case activity instance (== as the id of the runtime activity).
String	getParentCaseActivityInstanceId() The id of the parent case activity instance.
String	getTaskId() The corresponding task in case of a human task activity.
String	getTenantId() The id of the tenant this historic case activity instance belongs to.
boolean	isActive() Check if the case activity is active.
boolean	isAvailable() Check if the case activity is available.
boolean	isCompleted() Check if the case activity is completed.
boolean	isDisabled() Check if the case activity is disabled.
boolean	isEnabled() Check if the case activity is enabled.
boolean	isRequired() Check if the case activity is required.
boolean	isTerminated() Check if the case activity is terminated.

Method Detail

getId

String getId()

The id of the case activity instance (== as the id of the runtime activity).

getParentCaseActivityInstanceId

String getParentCaseActivityInstanceId()

The id of the parent case activity instance.

getCaseActivityId

String getCaseActivityId()

The unique identifier of the case activity in the case.

getCaseActivityName

String getCaseActivityName()

The display name for the case activity.

getCaseActivityType

String getCaseActivityType()

The display type for the case activity.

getCaseDefinitionId

String getCaseDefinitionId()

The case definition reference.

getCaseInstanceId

String getCaseInstanceId()

The case instance reference.

getCaseExecutionId

String getCaseExecutionId()

The case execution reference.

getTaskId

String getTaskId()

The corresponding task in case of a human task activity.

getCalledProcessInstanceId

String getCalledProcessInstanceId()

The corresponding process in case of a process task activity.

getCalledCaseInstanceId

String getCalledCaseInstanceId()

The corresponding case in case of a case task activity.

getTenantId

String getTenantId()

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

getCreateTime

Date getCreateTime()

The time when the case activity was created.

getEndTime

Date getEndTime()

The time when the case activity ended

getDurationInMillis

Long getDurationInMillis()

Difference between getEndTime() and getCreateTime().

isRequired

boolean isRequired()

Check if the case activity is required.

isAvailable

boolean isAvailable()

Check if the case activity is available.

isEnabled

boolean isEnabled()

Check if the case activity is enabled.

isDisabled

boolean isDisabled()

Check if the case activity is disabled.

isActive

boolean isActive()

Check if the case activity is active.

isCompleted

boolean isCompleted()

Check if the case activity is completed.

isTerminated

boolean isTerminated()

Check if the case activity is terminated.