org.camunda.bpm.engine.impl.persistence.entity
Class HistoricVariableInstanceEntity

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

All Implemented Interfaces:

Serializable, CoreVariableInstance, PersistentVariableInstance, HistoricVariableInstance, DbEntity, HasDbRevision, ValueFields

public class HistoricVariableInstanceEntity
extends Object
implements ValueFields, HistoricVariableInstance, DbEntity, HasDbRevision, Serializable

Author:

Christian Lipphardt (camunda)

See Also:

Serialized Form

Field Summary

protected String	activityInstanceId
protected String	byteArrayId
protected ByteArrayEntity	byteArrayValue
protected Object	cachedValue
protected String	dataFormatId
protected Double	doubleValue
protected String	errorMessage
protected String	executionId
protected String	id
protected Long	longValue
protected String	name
protected String	processInstanceId
protected int	revision
protected String	taskId
protected String	textValue
protected String	textValue2
protected VariableType	variableType
protected String	variableTypeName

Constructor Summary

HistoricVariableInstanceEntity()

HistoricVariableInstanceEntity(HistoricVariableUpdateEventEntity historyEvent)

Method Summary

void	delete()
protected void	deleteByteArrayValue()
String	getActivityInstanceId() Returns the corresponding activity instance id.
String	getActivtyInstanceId() Deprecated.
String	getByteArrayId()
ByteArrayEntity	getByteArrayValue()
String	getByteArrayValueId()
Object	getCachedValue()
String	getDataFormatId()
Double	getDoubleValue()
String	getErrorMessage() If the variable value could not be loaded, this returns the error message.
String	getExecutionId()
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	getProcessInstanceId() The process instance reference.
int	getRevision()
int	getRevisionNext()
SerializedVariableValue	getSerializedValue() Returns the value of this variable in its serialized form, represented by a SerializedVariableValue.
String	getTaskId()
String	getTextValue()
String	getTextValue2()
String	getTypeName() Returns the name of the type of this variable instance; corresponds to the types defined in ProcessEngineVariableType.
Object	getValue() Returns the value of this variable instance.
String	getValueTypeName() Returns the simple name of the class of the persisted variable
String	getVariableName() Returns the name of this variable instance.
VariableType	getVariableType()
String	getVariableTypeName() Returns the name of the type of this variable instance
void	setActivityInstanceId(String activityInstanceId)
void	setByteArrayId(String byteArrayId)
void	setByteArrayValue(byte[] bytes)
void	setByteArrayValue(ByteArrayEntity byteArrayValue)
void	setCachedValue(Object cachedValue)
void	setDataFormatId(String dataFormatId)
void	setDoubleValue(Double doubleValue)
void	setExecutionId(String executionId)
void	setId(String id)
void	setLongValue(Long longValue)
void	setName(String name)
void	setProcessInstanceId(String processInstanceId)
void	setRevision(int revision)
void	setTaskId(String taskId)
void	setTextValue(String textValue)
void	setTextValue2(String textValue2)
void	setVariableType(VariableType variableType)
boolean	storesCustomObjects() Returns whether this variable potentially stores a custom java object (i.e.
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

id

protected String id

processInstanceId

protected String processInstanceId

taskId

protected String taskId

executionId

protected String executionId

activityInstanceId

protected String activityInstanceId

name

protected String name

revision

protected int revision

variableTypeName

protected String variableTypeName

variableType

protected VariableType variableType

longValue

protected Long longValue

doubleValue

protected Double doubleValue

textValue

protected String textValue

textValue2

protected String textValue2

byteArrayValue

protected ByteArrayEntity byteArrayValue

byteArrayId

protected String byteArrayId

cachedValue

protected Object cachedValue

errorMessage

protected String errorMessage

dataFormatId

protected String dataFormatId

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: CoreVariableInstance

Returns the value of this variable instance.

Specified by:

getValue in interface CoreVariableInstance

getByteArrayValueId

public String getByteArrayValueId()

Specified by:

getByteArrayValueId in interface ValueFields

getByteArrayId

public String getByteArrayId()

setByteArrayId

public void setByteArrayId(String byteArrayId)

getByteArrayValue

public ByteArrayEntity getByteArrayValue()

Specified by:

getByteArrayValue in interface ValueFields

setByteArrayValue

public void setByteArrayValue(byte[] bytes)

Specified by:

setByteArrayValue in interface ValueFields

deleteByteArrayValue

protected void deleteByteArrayValue()

getTypeName

public String getTypeName()

Description copied from interface: PersistentVariableInstance

Returns the name of the type of this variable instance; corresponds to the types defined in ProcessEngineVariableType.

Specified by:

getTypeName in interface PersistentVariableInstance

getVariableTypeName

public String getVariableTypeName()

Description copied from interface: HistoricVariableInstance

Returns the name of the type of this variable instance

Deprecated since 7.2: use PersistentVariableInstance.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 CoreVariableInstance.getName() instead.

Specified by:

getVariableName in interface HistoricVariableInstance

getVariableType

public VariableType getVariableType()

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: CoreVariableInstance

Returns the name of this variable instance.

Specified by:

getName in interface CoreVariableInstance

Specified by:

getName in interface ValueFields

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)

getCachedValue

public Object getCachedValue()

Specified by:

getCachedValue in interface ValueFields

setCachedValue

public void setCachedValue(Object cachedValue)

Specified by:

setCachedValue in interface ValueFields

setVariableType

public void setVariableType(VariableType variableType)

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

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

getProcessInstanceId

public String getProcessInstanceId()

Description copied from interface: HistoricVariableInstance

The process instance reference.

Specified by:

getProcessInstanceId in interface HistoricVariableInstance

getTaskId

public String getTaskId()

setTaskId

public void setTaskId(String taskId)

getExecutionId

public String getExecutionId()

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)

getErrorMessage

public String getErrorMessage()

Description copied from interface: PersistentVariableInstance

If the variable value could not be loaded, this returns the error message.

Specified by:

getErrorMessage in interface PersistentVariableInstance

Returns:

an error message indicating why the variable value could not be loaded.

getDataFormatId

public String getDataFormatId()

Specified by:

getDataFormatId in interface ValueFields

setDataFormatId

public void setDataFormatId(String dataFormatId)

Specified by:

setDataFormatId in interface ValueFields

getSerializedValue

public SerializedVariableValue getSerializedValue()

Description copied from interface: PersistentVariableInstance

Returns the value of this variable in its serialized form, represented by a SerializedVariableValue.

Specified by:

getSerializedValue in interface PersistentVariableInstance

getValueTypeName

public String getValueTypeName()

Description copied from interface: PersistentVariableInstance

Returns the simple name of the class of the persisted variable

Specified by:

getValueTypeName in interface PersistentVariableInstance

storesCustomObjects

public boolean storesCustomObjects()

Description copied from interface: PersistentVariableInstance

Returns whether this variable potentially stores a custom java object (i.e. an instance of a non-JDK class). Return value is determined based on the underlying variable type (cf. ProcessEngineVariableType).

Specified by:

storesCustomObjects in interface PersistentVariableInstance

toString

public String toString()

Overrides:

toString in class Object