org.camunda.bpm.engine.delegate
Interface SerializedVariableValue

All Known Implementing Classes:

SerializedVariableValueImpl

public interface SerializedVariableValue

The serialized representation of a process variable. Depending on the variable type, it can have different values and configurations. Confer ProcessEngineVariableType for documentation of the default variable types.

Creating a SerializedVariableValue

The SerializedVariableValueBuilder can be used for creating an instance of SerializedVariableValue:

 SerializedVariableValue serializedValue = SerializedVariableValueBuilder.create()
   .value("{\"someProp\": 1}")
   .configValue(ProcessEngineVariableType.SPIN_TYPE_DATA_FORMAT_ID, "application/json")
 .done();
 

Author:

Thorben Lindhauer

Method Summary

Map<String,Object>	getConfig() Returns variable configuration that is required for the serialized that provides meaning to the serialized value.
Object	getValue() Returns the serialized representation of the variable.

Method Detail

getValue

Object getValue()

Returns the serialized representation of the variable. For primitive types (integer, string, etc.), serialized values are the same as the regular values. For object types, serialized values return the representation of these objects as stored in the database.

getConfig

Map<String,Object> getConfig()

Returns variable configuration that is required for the serialized that provides meaning to the serialized value. For example, the configuration could contain the class name of the serialized object. The actual configuration depends on the VariableType; These classes also provide constants for accessing the expected configuration properties.