org.camunda.bpm.engine.delegate
Interface ProcessEngineVariableType

All Known Implementing Classes:

DefaultProcessEngineVariableType

public interface ProcessEngineVariableType

This enum provides the variable types that the process engine uses. A variable type is responsible for persisting a variable in a specific format. Thus, a type consists of a name, the java types it can persist, the java types of the serialized representation this type creates and additional variable configuration options.

Type Name	Type of Persisted Value	Type of Serialized Value	Configuration Settings	Additional Remarks
boolean	Boolean	Boolean	No configuration
bytes	byte[]	byte[]	No configuration
short	Short	Short	No configuration
integer	Integer	Integer	No configuration
long	Long	Long	No configuration
double	Double	Double	No configuration
date	Date	Long	No configuration	Serialized value is time in millis since 1/1/1970
serializable	<Custom Class> implements Serializable	byte[]	No configuration	Applies standard Java object serialization
null	null	null	No configuration
string	String	String	No configuration
jpa-entity	<JPA Entity>	null	JPA_TYPE_CONFIG_CLASS_NAME JPA_TYPE_CONFIG_ENTITY_ID	The serialized value is null as the variable only stores a reference to a JPA Entity
spin-serialization	<Custom Class>	String	SPIN_TYPE_DATA_FORMAT_ID SPIN_TYPE_CONFIG_ROOT_TYPE	This type persists variables using the camunda Spin library. The serialized value corresponds to the serialization formats it offers and that the format that is configured in the process engine.

Author:

Thorben Lindhauer

Field Summary

static ProcessEngineVariableType	BOOLEAN Name "boolean" Value is of type Boolean No configuration
static ProcessEngineVariableType	BYTES Name "bytes" Value is is of type byte[] No configuration
static ProcessEngineVariableType	DATE Name "date" Value is of type Date No configuration
static ProcessEngineVariableType	DOUBLE Name "double" Value is of type Double No configuration
static ProcessEngineVariableType	INTEGER Name "integer" Value is of type Integer No configuration
static ProcessEngineVariableType	JPA Name "jpa-entity" Value is a JPA Entity Required configuration parameters are: JPA_TYPE_CONFIG_CLASS_NAME and JPA_TYPE_CONFIG_ENTITY_ID
static String	JPA_TYPE_CONFIG_CLASS_NAME The class name of the JPA entity as a String.
static String	JPA_TYPE_CONFIG_ENTITY_ID The id of the JPA entity as a String value.
static ProcessEngineVariableType	LONG Name "long" Value is of type Long No configuration
static ProcessEngineVariableType	NULL Name "null" Value is null No configuration
static ProcessEngineVariableType	SERIALIZABLE Name "serializable" Value is of type that implements Serializable No configuration
static ProcessEngineVariableType	SHORT Name "short" Value is of type Short No configuration
static ProcessEngineVariableType	SPIN Name "SpinSerialization" Value is of type String Required configuration parameters are: SPIN_TYPE_DATA_FORMAT_ID and SPIN_TYPE_CONFIG_ROOT_TYPE
static String	SPIN_TYPE_CONFIG_ROOT_TYPE The java type identifier that represents the root of this object.
static String	SPIN_TYPE_DATA_FORMAT_ID The name of the Spin data format that can handle the serialized input; String.
static ProcessEngineVariableType	STRING Name "string" Value is of type String No configuration

Method Summary

String

getName() Returns the canonical name of the variable type

Field Detail

BOOLEAN

static final ProcessEngineVariableType BOOLEAN

• Name "boolean"
• Value is of type Boolean
• No configuration

BYTES

static final ProcessEngineVariableType BYTES

• Name "bytes"
• Value is is of type byte[]
• No configuration

SHORT

static final ProcessEngineVariableType SHORT

• Name "short"
• Value is of type Short
• No configuration

LONG

static final ProcessEngineVariableType LONG

• Name "long"
• Value is of type Long
• No configuration

DOUBLE

static final ProcessEngineVariableType DOUBLE

• Name "double"
• Value is of type Double
• No configuration

DATE

static final ProcessEngineVariableType DATE

• Name "date"
• Value is of type Date
• No configuration

SERIALIZABLE

static final ProcessEngineVariableType SERIALIZABLE

• Name "serializable"
• Value is of type that implements Serializable
• No configuration

NULL

static final ProcessEngineVariableType NULL

• Name "null"
• Value is null
• No configuration

STRING

static final ProcessEngineVariableType STRING

• Name "string"
• Value is of type String
• No configuration

INTEGER

static final ProcessEngineVariableType INTEGER

• Name "integer"
• Value is of type Integer
• No configuration

JPA

static final ProcessEngineVariableType JPA

• Name "jpa-entity"
• Value is a JPA Entity
• Required configuration parameters are: JPA_TYPE_CONFIG_CLASS_NAME and JPA_TYPE_CONFIG_ENTITY_ID

SPIN

static final ProcessEngineVariableType SPIN

• Name "SpinSerialization"
• Value is of type String
• Required configuration parameters are: SPIN_TYPE_DATA_FORMAT_ID and SPIN_TYPE_CONFIG_ROOT_TYPE

SPIN_TYPE_DATA_FORMAT_ID

static final String SPIN_TYPE_DATA_FORMAT_ID

The name of the Spin data format that can handle the serialized input; String.

See Also:

Constant Field Values

SPIN_TYPE_CONFIG_ROOT_TYPE

static final String SPIN_TYPE_CONFIG_ROOT_TYPE

The java type identifier that represents the root of this object. Has to correspond to the spin data format's canonical type name. Has to be a String value.

See Also:

Constant Field Values

JPA_TYPE_CONFIG_CLASS_NAME

static final String JPA_TYPE_CONFIG_CLASS_NAME

The class name of the JPA entity as a String.

See Also:

Constant Field Values

JPA_TYPE_CONFIG_ENTITY_ID

static final String JPA_TYPE_CONFIG_ENTITY_ID

The id of the JPA entity as a String value.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the canonical name of the variable type