Package org.activiti.engine.impl.variable

Class JPAEntityVariableType

java.lang.Object

org.activiti.engine.impl.variable.JPAEntityVariableType

All Implemented Interfaces:

CacheableVariable, VariableType

Direct Known Subclasses:

HistoricJPAEntityVariableType

public class JPAEntityVariableType
extends Object
implements VariableType, CacheableVariable

Variable type capable of storing reference to JPA-entities. Only JPA-Entities which are configured by annotations are supported. Use of compound primary keys is not supported.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE_NAME

Constructor Summary

Constructors

Constructor	Description
JPAEntityVariableType()

Method Summary

Modifier and Type	Method	Description
String	getTypeName()	name of variable type (limited to 100 characters length)
Object	getValue(ValueFields valueFields)
boolean	isAbleToStore(Object value)
boolean	isCachable()	Indicates if this variable type supports caching.
void	setForceCacheable(boolean forceCachedValue)	Force the value to be cacheable.
void	setValue(Object value, ValueFields valueFields)	Stores the specified value in the supplied ValueFields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_NAME

public static final String TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

JPAEntityVariableType

public JPAEntityVariableType()

Method Detail

getTypeName

public String getTypeName()

Description copied from interface: VariableType

name of variable type (limited to 100 characters length)

Specified by:

getTypeName in interface VariableType

isCachable

public boolean isCachable()

Description copied from interface: VariableType

Indicates if this variable type supports caching.

If caching is supported, the result of VariableType.getValue(ValueFields) is saved for the duration of the session and used for subsequent reads of the variable's value.

If caching is not supported, all reads of a variable's value require a fresh call to VariableType.getValue(ValueFields).

Specified by:

isCachable in interface VariableType

Returns:

whether variables of this type are cacheable.

isAbleToStore

public boolean isAbleToStore(Object value)

Specified by:

isAbleToStore in interface VariableType

Returns:

whether this variable type can store the specified value.

setValue

public void setValue(Object value,
                     ValueFields valueFields)

Description copied from interface: VariableType

Stores the specified value in the supplied ValueFields.

Specified by:

setValue in interface VariableType

getValue

public Object getValue(ValueFields valueFields)

Specified by:

getValue in interface VariableType

Returns:

the value of a variable based on the specified ValueFields.

setForceCacheable

public void setForceCacheable(boolean forceCachedValue)

Force the value to be cacheable.

Specified by:

setForceCacheable in interface CacheableVariable