Package 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, Askar Akhmerov

    • Method Detail

      • getId

        java.lang.String getId()
        The process instance id (== as the id for the runtime process instance).

      • getBusinessKey

        java.lang.String getBusinessKey()
        The user provided unique reference to this process instance.

      • getProcessDefinitionKey

        java.lang.String getProcessDefinitionKey()
        The process definition key reference.

      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        The process definition reference.

      • getProcessDefinitionName

        java.lang.String getProcessDefinitionName()
        The process definition name.

      • getProcessDefinitionVersion

        java.lang.Integer getProcessDefinitionVersion()
        The process definition version.

      • getStartTime

        java.util.Date getStartTime()
        The time the process was started.

      • getEndTime

        java.util.Date getEndTime()
        The time the process was ended.

      • getRemovalTime

        java.util.Date getRemovalTime()
        The time the historic process instance will be removed.

      • getEndActivityId

        @Deprecated
java.lang.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)

      • getStartActivityId

        java.lang.String getStartActivityId()
        The start activity.

      • getDeleteReason

        java.lang.String getDeleteReason()
        Obtains the reason for the process instance's deletion.

      • getSuperProcessInstanceId

        java.lang.String getSuperProcessInstanceId()
        The process instance id of a potential super process instance or null if no super process instance exists

      • getRootProcessInstanceId

        java.lang.String getRootProcessInstanceId()
        The process instance id of the top-level (root) process instance or null if no root process instance exists

      • getSuperCaseInstanceId

        java.lang.String getSuperCaseInstanceId()
        The case instance id of a potential super case instance or null if no super case instance exists

      • getCaseInstanceId

        java.lang.String getCaseInstanceId()
        The case instance id of a potential super case instance or null if no super case instance exists

      • getTenantId

        java.lang.String getTenantId()
        The id of the tenant this historic process instance belongs to. Can be null if the historic process instance belongs to no single tenant.

      • getState

        java.lang.String getState()
        Return current state of HistoricProcessInstance, following values are recognized during process engine operations: STATE_ACTIVE - running process instance STATE_SUSPENDED - suspended process instances STATE_COMPLETED - completed through normal end event STATE_EXTERNALLY_TERMINATED - terminated externally, for instance through REST API STATE_INTERNALLY_TERMINATED - terminated internally, for instance by terminating boundary event