org.camunda.bpm.engine.history

Interface HistoricVariableUpdate

All Superinterfaces:

HistoricDetail

All Known Implementing Classes:

HistoricDetailVariableInstanceUpdateEntity

public interface HistoricVariableUpdate
extends HistoricDetail

Update of a process variable. This is only available if history level is configured to FULL.

Author:

Tom Baeyens

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage() If the variable value could not be loaded, this returns the error message.
int	getRevision()
TypedValue	getTypedValue()
String	getTypeName() Returns the type name of the variable
Object	getValue()
String	getVariableInstanceId() Returns the id of the corresponding variable instance.
String	getVariableName()
String	getVariableTypeName() Deprecated. since 7.2. Use getTypeName()
Boolean	isInitial()

Methods inherited from interface org.camunda.bpm.engine.history.HistoricDetail

getActivityInstanceId, getCaseDefinitionId, getCaseDefinitionKey, getCaseExecutionId, getCaseInstanceId, getExecutionId, getId, getProcessDefinitionId, getProcessDefinitionKey, getProcessInstanceId, getRemovalTime, getRootProcessInstanceId, getTaskId, getTenantId, getTime, getUserOperationId

Method Detail

getVariableName

String getVariableName()

getVariableInstanceId

String getVariableInstanceId()

Returns the id of the corresponding variable instance.

getTypeName

String getTypeName()

Returns the type name of the variable

Returns:

the type name of the variable

getVariableTypeName

@Deprecated
String getVariableTypeName()

Deprecated. since 7.2. Use getTypeName()

Returns:

the name of the variable type.

getValue

Object getValue()

getTypedValue

TypedValue getTypedValue()

Returns:

the TypedValue for this variable update

getRevision

int getRevision()

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.

isInitial

Boolean isInitial()

Returns:

true if the detail historic variable update is created during the process instance start