Package org.camunda.bpm.engine.history

Interface HistoricVariableInstance

All Known Implementing Classes:
HistoricVariableInstanceEntity
public interface HistoricVariableInstance
A single process variable containing the last value when its process instance has finished. It is only available when HISTORY_LEVEL is set >= AUDIT
Author:
Christian Lipphardt (camunda), ruecker

  • Field Details

  • Method Details

    • getId

      String getId()
      Returns:
      the Id of this variable instance

    • getName

      String getName()
      Returns the name of this variable instance.

    • getTypeName

      String getTypeName()
      Returns the name of the type of this variable instance
      Returns:
      the type name of the variable

    • getValue

      Object getValue()
      Returns the value of this variable instance.

    • getTypedValue

      TypedValue getTypedValue()
      Returns the TypedValue of this variable instance.

    • getVariableName

      @Deprecated String getVariableName()
      Deprecated.
      Returns the name of this variable instance.

      Deprecated since 7.2: use getName() instead.

    • getVariableTypeName

      @Deprecated String getVariableTypeName()
      Deprecated.

      Returns the name of the type of this variable instance

      Deprecated since 7.2: use getTypeName() instead.

    • getProcessDefinitionKey

      String getProcessDefinitionKey()
      The process definition key reference.

    • getProcessDefinitionId

      String getProcessDefinitionId()
      The process definition reference.

    • getRootProcessInstanceId

      String getRootProcessInstanceId()
      The root process instance reference.

    • getProcessInstanceId

      String getProcessInstanceId()
      The process instance reference.

    • getExecutionId

      String getExecutionId()
      Return the corresponding execution id.

    • getActivtyInstanceId

      @Deprecated String getActivtyInstanceId()
      Deprecated.
      Returns the corresponding activity instance id.

    • getActivityInstanceId

      String getActivityInstanceId()
      Returns the corresponding activity instance id.

    • getCaseDefinitionKey

      String getCaseDefinitionKey()
      The case definition key reference.

    • getCaseDefinitionId

      String getCaseDefinitionId()
      The case definition reference.

    • getCaseInstanceId

      String getCaseInstanceId()
      The case instance reference.

    • getCaseExecutionId

      String getCaseExecutionId()
      Return the corresponding case execution id.

    • getTaskId

      String getTaskId()
      Return the corresponding task id.

    • getErrorMessage

      String getErrorMessage()
      If the variable value could not be loaded, this returns the error message.
      Returns:
      an error message indicating why the variable value could not be loaded.

    • getTenantId

      String getTenantId()
      The id of the tenant this variable belongs to. Can be null if the variable belongs to no single tenant.

    • getState

      String getState()
      The current state of the variable. Can be 'CREATED' or 'DELETED'

    • getCreateTime

      Date getCreateTime()
      The time when the variable was created.

    • getRemovalTime

      Date getRemovalTime()
      The time when the historic variable instance will be removed.