com.flowable.dataobject.api.runtime

Interface DataObjectInstanceVariableContainer

All Superinterfaces:

VariableContainer

All Known Implementing Classes:

DataObjectInstanceVariableContainerImpl, DetachedDataObjectInstanceVariableContainer

public interface DataObjectInstanceVariableContainer
extends VariableContainer

A data object instance variable container.

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method and Description
default Boolean	getBoolean(String property)
Object	getData()
default Date	getDate(String property)
String	getDefinitionId() Returns the id of the master data definition this instance belongs to.
String	getDefinitionKey() Returns the key of the master data definition this instance belongs to.
default Double	getDouble(String property)
Object	getId()
default Integer	getInteger(String property)
default Long	getLong(String property)
Object	getLookupId() Returns the lookup id of this data object instance, which needs to be unique only within the same data object definition and source.
default String	getString(String property)
String	getTenantId() The tenant id of the definition
<T> T	getValue(String property, Class<T> valueType) Get a value for the given property with the give valueType
default Object	getVariable(String variableName)
boolean	hasValue(String property) Check whether the data object instance has the given property
default boolean	hasVariable(String variableName)
Iterable<String>	propertyNames() An iterable of all the names of the properties for this data object instance.
default Object	removeValue(String property)
<T> T	removeValue(String property, Class<T> propertyClass)
void	setId(Object id)
<T> void	setValue(String property, T value)
default void	setVariable(String variableName, Object variableValue)

Methods inherited from interface org.flowable.common.engine.api.variable.VariableContainer

setTransientVariable

Method Detail

getId

Object getId()

setId

void setId(Object id)

getLookupId

Object getLookupId()

Returns the lookup id of this data object instance, which needs to be unique only within the same data object definition and source.

Returns:

the lookup id of this data object, as given and used by the data source managing this data object instance

getDefinitionId

String getDefinitionId()

Returns the id of the master data definition this instance belongs to.

Returns:

the id of the master data definition

getDefinitionKey

String getDefinitionKey()

Returns the key of the master data definition this instance belongs to.

Returns:

the key of the master data definition

getString

default String getString(String property)

getBoolean

default Boolean getBoolean(String property)

getInteger

default Integer getInteger(String property)

getLong

default Long getLong(String property)

getDouble

default Double getDouble(String property)

getDate

default Date getDate(String property)

getValue

<T> T getValue(String property,
               Class<T> valueType)

Get a value for the given property with the give valueType

Type Parameters:

T - the type of the value

Parameters:

property - the name of the property

valueType - the type of the value

Returns:

the value for the given property

hasValue

boolean hasValue(String property)

Check whether the data object instance has the given property

Parameters:

property - the name of the property

Returns:

true if this data object instance has a property with given name, false otherwise

hasVariable

default boolean hasVariable(String variableName)

Specified by:

hasVariable in interface VariableContainer

getVariable

default Object getVariable(String variableName)

Specified by:

getVariable in interface VariableContainer

setValue

<T> void setValue(String property,
                  T value)

removeValue

default Object removeValue(String property)

removeValue

<T> T removeValue(String property,
                  Class<T> propertyClass)

setVariable

default void setVariable(String variableName,
                         Object variableValue)

Specified by:

setVariable in interface VariableContainer

getTenantId

String getTenantId()

The tenant id of the definition

Specified by:

getTenantId in interface VariableContainer

Returns:

the tenant id of the definition

propertyNames

Iterable<String> propertyNames()

An iterable of all the names of the properties for this data object instance.

Returns:

iterator of the properties

getData

Object getData()