HistoricVariableInstanceEntity (Camunda BPM Javadocs 7.13.18-ee)

java.lang.Object
- org.camunda.bpm.engine.impl.persistence.entity.HistoricVariableInstanceEntity

All Implemented Interfaces:

Serializable, HistoricVariableInstance, DbEntity, DbEntityLifecycleAware, HasDbRevision, HistoricEntity, Nameable, ValueFields
```
public class HistoricVariableInstanceEntity
extends Object
implements ValueFields, HistoricVariableInstance, DbEntity, HasDbRevision, HistoricEntity, Serializable, DbEntityLifecycleAware
```
Author:

Christian Lipphardt (camunda)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`activityInstanceId`
`protected ByteArrayField`	`byteArrayField`
`protected String`	`caseDefinitionId`
`protected String`	`caseDefinitionKey`
`protected String`	`caseExecutionId`
`protected String`	`caseInstanceId`
`protected Date`	`createTime`
`protected Double`	`doubleValue`
`protected String`	`executionId`
`protected String`	`id`
`protected static EnginePersistenceLogger`	`LOG`
`protected Long`	`longValue`
`protected String`	`name`
`protected String`	`processDefinitionId`
`protected String`	`processDefinitionKey`
`protected String`	`processInstanceId`
`protected Date`	`removalTime`
`protected int`	`revision`
`protected String`	`rootProcessInstanceId`
`protected String`	`state`
`protected String`	`taskId`
`protected String`	`tenantId`
`protected String`	`textValue`
`protected String`	`textValue2`
`protected TypedValueField`	`typedValueField`

Fields inherited from interface org.camunda.bpm.engine.history.HistoricVariableInstance
STATE_CREATED, STATE_DELETED

Constructor Summary

Constructors
Constructor and Description

HistoricVariableInstanceEntity()

HistoricVariableInstanceEntity(HistoricVariableUpdateEventEntity historyEvent)

Constructors
Constructor and Description
`HistoricVariableInstanceEntity()`
`HistoricVariableInstanceEntity(HistoricVariableUpdateEventEntity historyEvent)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`delete()`
`String`	`getActivityInstanceId()` Returns the corresponding activity instance id.
`String`	`getActivtyInstanceId()` Deprecated.
`String`	`getByteArrayId()`
`byte[]`	`getByteArrayValue()`
`String`	`getByteArrayValueId()`
`String`	`getCaseDefinitionId()` The case definition reference.
`String`	`getCaseDefinitionKey()` The case definition key reference.
`String`	`getCaseExecutionId()` Return the corresponding case execution id.
`String`	`getCaseInstanceId()` The case instance reference.
`Date`	`getCreateTime()` The time when the variable was created.
`Double`	`getDoubleValue()`
`String`	`getErrorMessage()` If the variable value could not be loaded, this returns the error message.
`String`	`getExecutionId()` Return the corresponding execution id.
`String`	`getId()`
`Long`	`getLongValue()`
`String`	`getName()` Returns the name of this variable instance.
`Object`	`getPersistentState()` Returns a representation of the object, as would be stored in the database.
`String`	`getProcessDefinitionId()` The process definition reference.
`String`	`getProcessDefinitionKey()` The process definition key reference.
`String`	`getProcessInstanceId()` The process instance reference.
`Date`	`getRemovalTime()` The time when the historic variable instance will be removed.
`int`	`getRevision()`
`int`	`getRevisionNext()`
`String`	`getRootProcessInstanceId()` The root process instance reference.
`TypedValueSerializer<?>`	`getSerializer()`
`String`	`getSerializerName()`
`String`	`getState()` The current state of the variable.
`String`	`getTaskId()` Return the corresponding task id.
`String`	`getTenantId()` The id of the tenant this variable belongs to.
`String`	`getTextValue()`
`String`	`getTextValue2()`
`TypedValue`	`getTypedValue()` Returns the `TypedValue` of this variable instance.
`TypedValue`	`getTypedValue(boolean deserializeValue)`
`String`	`getTypeName()` Returns the name of the type of this variable instance
`Object`	`getValue()` Returns the value of this variable instance.
`String`	`getVariableName()` Returns the name of this variable instance.
`String`	`getVariableTypeName()` Returns the name of the type of this variable instance
`void`	`postLoad()`
`void`	`setActivityInstanceId(String activityInstanceId)`
`void`	`setByteArrayId(String byteArrayId)`
`void`	`setByteArrayValue(byte[] bytes)`
`void`	`setByteArrayValue(ByteArrayEntity byteArrayValue)`
`void`	`setCaseDefinitionId(String caseDefinitionId)`
`void`	`setCaseDefinitionKey(String caseDefinitionKey)`
`void`	`setCaseExecutionId(String caseExecutionId)`
`void`	`setCaseInstanceId(String caseInstanceId)`
`void`	`setCreateTime(Date createTime)`
`void`	`setDoubleValue(Double doubleValue)`
`void`	`setExecutionId(String executionId)`
`void`	`setId(String id)`
`void`	`setLongValue(Long longValue)`
`void`	`setName(String name)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionKey(String processDefinitionKey)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setRemovalTime(Date removalTime)`
`void`	`setRevision(int revision)`
`void`	`setRootProcessInstanceId(String rootProcessInstanceId)`
`void`	`setSerializerName(String serializerName)`
`void`	`setState(String state)`
`void`	`setTaskId(String taskId)`
`void`	`setTenantId(String tenantId)`
`void`	`setTextValue(String textValue)`
`void`	`setTextValue2(String textValue2)`
`String`	`toString()`
`void`	`updateFromEvent(HistoricVariableUpdateEventEntity historyEvent)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
protected static final EnginePersistenceLogger LOG
```
  - id
```
protected String id
```
  - processDefinitionKey
```
protected String processDefinitionKey
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - rootProcessInstanceId
```
protected String rootProcessInstanceId
```
  - processInstanceId
```
protected String processInstanceId
```
  - taskId
```
protected String taskId
```
  - executionId
```
protected String executionId
```
  - activityInstanceId
```
protected String activityInstanceId
```
  - tenantId
```
protected String tenantId
```
  - caseDefinitionKey
```
protected String caseDefinitionKey
```
  - caseDefinitionId
```
protected String caseDefinitionId
```
  - caseInstanceId
```
protected String caseInstanceId
```
  - caseExecutionId
```
protected String caseExecutionId
```
  - name
```
protected String name
```
  - revision
```
protected int revision
```
  - createTime
```
protected Date createTime
```
  - longValue
```
protected Long longValue
```
  - doubleValue
```
protected Double doubleValue
```
  - textValue
```
protected String textValue
```
  - textValue2
```
protected String textValue2
```
  - state
```
protected String state
```
  - removalTime
```
protected Date removalTime
```
  - byteArrayField
```
protected ByteArrayField byteArrayField
```
  - typedValueField
```
protected TypedValueField typedValueField
```
- Constructor Detail
  - HistoricVariableInstanceEntity
```
public HistoricVariableInstanceEntity()
```
  - HistoricVariableInstanceEntity
```
public HistoricVariableInstanceEntity(HistoricVariableUpdateEventEntity historyEvent)
```
- Method Detail
  - updateFromEvent
```
public void updateFromEvent(HistoricVariableUpdateEventEntity historyEvent)
```
  - delete
```
public void delete()
```
  - getPersistentState
```
public Object getPersistentState()
```
    Description copied from interface: DbEntity
    
    Returns a representation of the object, as would be stored in the database. Used when deciding if updates have occurred to the object or not since it was last loaded.
    
    Specified by:
    
    getPersistentState in interface DbEntity
  - getRevisionNext
```
public int getRevisionNext()
```
    Specified by:
    
    getRevisionNext in interface HasDbRevision
  - getValue
```
public Object getValue()
```
    Description copied from interface: HistoricVariableInstance
    
    Returns the value of this variable instance.
    
    Specified by:
    
    getValue in interface HistoricVariableInstance
  - getTypedValue
```
public TypedValue getTypedValue()
```
    Description copied from interface: HistoricVariableInstance
    
    Returns the TypedValue of this variable instance.
    
    Specified by:
    
    getTypedValue in interface HistoricVariableInstance
  - getTypedValue
```
public TypedValue getTypedValue(boolean deserializeValue)
```
  - getSerializer
```
public TypedValueSerializer<?> getSerializer()
```
  - getByteArrayValueId
```
public String getByteArrayValueId()
```
  - getByteArrayId
```
public String getByteArrayId()
```
  - setByteArrayId
```
public void setByteArrayId(String byteArrayId)
```
  - getByteArrayValue
```
public byte[] getByteArrayValue()
```
    Specified by:
    
    getByteArrayValue in interface ValueFields
  - setByteArrayValue
```
public void setByteArrayValue(byte[] bytes)
```
    Specified by:
    
    setByteArrayValue in interface ValueFields
  - postLoad
```
public void postLoad()
```
    Specified by:
    
    postLoad in interface DbEntityLifecycleAware
  - getSerializerName
```
public String getSerializerName()
```
  - setSerializerName
```
public void setSerializerName(String serializerName)
```
  - getTypeName
```
public String getTypeName()
```
    Description copied from interface: HistoricVariableInstance
    
    Returns the name of the type of this variable instance
    
    Specified by:
    
    getTypeName in interface HistoricVariableInstance
    
    Returns:
    
    the type name of the variable
  - getVariableTypeName
```
public String getVariableTypeName()
```
    Description copied from interface: HistoricVariableInstance
    
    Returns the name of the type of this variable instance
    
    Deprecated since 7.2: use HistoricVariableInstance.getTypeName() instead.
    
    Specified by:
    
    getVariableTypeName in interface HistoricVariableInstance
  - getVariableName
```
public String getVariableName()
```
    Description copied from interface: HistoricVariableInstance
    
    Returns the name of this variable instance.
    Deprecated since 7.2: use HistoricVariableInstance.getName() instead.
    
    Specified by:
    
    getVariableName in interface HistoricVariableInstance
  - getRevision
```
public int getRevision()
```
    Specified by:
    
    getRevision in interface HasDbRevision
  - setRevision
```
public void setRevision(int revision)
```
    Specified by:
    
    setRevision in interface HasDbRevision
  - getName
```
public String getName()
```
    Description copied from interface: HistoricVariableInstance
    
    Returns the name of this variable instance.
    
    Specified by:
    
    getName in interface HistoricVariableInstance
    
    Specified by:
    
    getName in interface Nameable
  - setName
```
public void setName(String name)
```
  - getLongValue
```
public Long getLongValue()
```
    Specified by:
    
    getLongValue in interface ValueFields
  - setLongValue
```
public void setLongValue(Long longValue)
```
    Specified by:
    
    setLongValue in interface ValueFields
  - getDoubleValue
```
public Double getDoubleValue()
```
    Specified by:
    
    getDoubleValue in interface ValueFields
  - setDoubleValue
```
public void setDoubleValue(Double doubleValue)
```
    Specified by:
    
    setDoubleValue in interface ValueFields
  - getTextValue
```
public String getTextValue()
```
    Specified by:
    
    getTextValue in interface ValueFields
  - setTextValue
```
public void setTextValue(String textValue)
```
    Specified by:
    
    setTextValue in interface ValueFields
  - getTextValue2
```
public String getTextValue2()
```
    Specified by:
    
    getTextValue2 in interface ValueFields
  - setTextValue2
```
public void setTextValue2(String textValue2)
```
    Specified by:
    
    setTextValue2 in interface ValueFields
  - setByteArrayValue
```
public void setByteArrayValue(ByteArrayEntity byteArrayValue)
```
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface HistoricVariableInstance
    
    Specified by:
    
    getId in interface DbEntity
    
    Returns:
    
    the Id of this variable instance
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in interface DbEntity
  - getProcessDefinitionKey
```
public String getProcessDefinitionKey()
```
    Description copied from interface: HistoricVariableInstance
    
    The process definition key reference.
    
    Specified by:
    
    getProcessDefinitionKey in interface HistoricVariableInstance
  - setProcessDefinitionKey
```
public void setProcessDefinitionKey(String processDefinitionKey)
```
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
    Description copied from interface: HistoricVariableInstance
    
    The process definition reference.
    
    Specified by:
    
    getProcessDefinitionId in interface HistoricVariableInstance
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
    Description copied from interface: HistoricVariableInstance
    
    The process instance reference.
    
    Specified by:
    
    getProcessInstanceId in interface HistoricVariableInstance
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
  - getTaskId
```
public String getTaskId()
```
    Description copied from interface: HistoricVariableInstance
    
    Return the corresponding task id.
    
    Specified by:
    
    getTaskId in interface HistoricVariableInstance
  - setTaskId
```
public void setTaskId(String taskId)
```
  - getExecutionId
```
public String getExecutionId()
```
    Description copied from interface: HistoricVariableInstance
    
    Return the corresponding execution id.
    
    Specified by:
    
    getExecutionId in interface HistoricVariableInstance
  - setExecutionId
```
public void setExecutionId(String executionId)
```
  - getActivtyInstanceId
```
@Deprecated
public String getActivtyInstanceId()
```
    Deprecated.
    
    Description copied from interface: HistoricVariableInstance
    
    Returns the corresponding activity instance id.
    
    Specified by:
    
    getActivtyInstanceId in interface HistoricVariableInstance
  - getActivityInstanceId
```
public String getActivityInstanceId()
```
    Description copied from interface: HistoricVariableInstance
    
    Returns the corresponding activity instance id.
    
    Specified by:
    
    getActivityInstanceId in interface HistoricVariableInstance
  - setActivityInstanceId
```
public void setActivityInstanceId(String activityInstanceId)
```
  - getCaseDefinitionKey
```
public String getCaseDefinitionKey()
```
    Description copied from interface: HistoricVariableInstance
    
    The case definition key reference.
    
    Specified by:
    
    getCaseDefinitionKey in interface HistoricVariableInstance
  - setCaseDefinitionKey
```
public void setCaseDefinitionKey(String caseDefinitionKey)
```
  - getCaseDefinitionId
```
public String getCaseDefinitionId()
```
    Description copied from interface: HistoricVariableInstance
    
    The case definition reference.
    
    Specified by:
    
    getCaseDefinitionId in interface HistoricVariableInstance
  - setCaseDefinitionId
```
public void setCaseDefinitionId(String caseDefinitionId)
```
  - getCaseInstanceId
```
public String getCaseInstanceId()
```
    Description copied from interface: HistoricVariableInstance
    
    The case instance reference.
    
    Specified by:
    
    getCaseInstanceId in interface HistoricVariableInstance
  - setCaseInstanceId
```
public void setCaseInstanceId(String caseInstanceId)
```
  - getCaseExecutionId
```
public String getCaseExecutionId()
```
    Description copied from interface: HistoricVariableInstance
    
    Return the corresponding case execution id.
    
    Specified by:
    
    getCaseExecutionId in interface HistoricVariableInstance
  - setCaseExecutionId
```
public void setCaseExecutionId(String caseExecutionId)
```
  - getErrorMessage
```
public String getErrorMessage()
```
    Description copied from interface: HistoricVariableInstance
    
    If the variable value could not be loaded, this returns the error message.
    
    Specified by:
    
    getErrorMessage in interface HistoricVariableInstance
    
    Returns:
    
    an error message indicating why the variable value could not be loaded.
  - getTenantId
```
public String getTenantId()
```
    Description copied from interface: HistoricVariableInstance
    
    The id of the tenant this variable belongs to. Can be null if the variable belongs to no single tenant.
    
    Specified by:
    
    getTenantId in interface HistoricVariableInstance
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - getState
```
public String getState()
```
    Description copied from interface: HistoricVariableInstance
    
    The current state of the variable. Can be 'CREATED' or 'DELETED'
    
    Specified by:
    
    getState in interface HistoricVariableInstance
  - setState
```
public void setState(String state)
```
  - getCreateTime
```
public Date getCreateTime()
```
    Description copied from interface: HistoricVariableInstance
    
    The time when the variable was created.
    
    Specified by:
    
    getCreateTime in interface HistoricVariableInstance
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
  - getRootProcessInstanceId
```
public String getRootProcessInstanceId()
```
    Description copied from interface: HistoricVariableInstance
    
    The root process instance reference.
    
    Specified by:
    
    getRootProcessInstanceId in interface HistoricVariableInstance
  - setRootProcessInstanceId
```
public void setRootProcessInstanceId(String rootProcessInstanceId)
```
  - getRemovalTime
```
public Date getRemovalTime()
```
    Description copied from interface: HistoricVariableInstance
    
    The time when the historic variable instance will be removed.
    
    Specified by:
    
    getRemovalTime in interface HistoricVariableInstance
  - setRemovalTime
```
public void setRemovalTime(Date removalTime)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HistoricVariableInstanceEntity

Field Summary

Fields inherited from interface org.camunda.bpm.engine.history.HistoricVariableInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

id

processDefinitionKey

processDefinitionId

rootProcessInstanceId

processInstanceId

taskId

executionId

activityInstanceId

tenantId

caseDefinitionKey

caseDefinitionId

caseInstanceId

caseExecutionId

name

revision

createTime

longValue

doubleValue

textValue

textValue2

state

removalTime

byteArrayField

typedValueField

Constructor Detail

HistoricVariableInstanceEntity

HistoricVariableInstanceEntity

Method Detail

updateFromEvent

delete

getPersistentState

getRevisionNext

getValue

getTypedValue

getTypedValue

getSerializer

getByteArrayValueId

getByteArrayId

setByteArrayId

getByteArrayValue

setByteArrayValue

postLoad

getSerializerName

setSerializerName

getTypeName

getVariableTypeName

getVariableName

getRevision

setRevision

getName

setName

getLongValue

setLongValue

getDoubleValue

setDoubleValue

getTextValue

setTextValue

getTextValue2

setTextValue2

setByteArrayValue

getId

setId

getProcessDefinitionKey

setProcessDefinitionKey

getProcessDefinitionId

setProcessDefinitionId

getProcessInstanceId

setProcessInstanceId

getTaskId

setTaskId

getExecutionId

setExecutionId