org.bonitasoft.engine.bpm.data

Interface DataInstance

All Superinterfaces:

BaseElement, BonitaObject, NamedElement, Serializable

All Known Subinterfaces:

ArchivedDataInstance

All Known Implementing Classes:

ArchivedDataInstanceImpl, BlobDataInstanceImpl, BooleanDataInstanceImpl, DataInstanceImpl, DateDataInstanceImpl, DoubleDataInstanceImpl, FloatDataInstanceImpl, IntegerDataInstanceImpl, LongDataInstanceImpl, LongTextDataInstanceImpl, ShortTextDataInstanceImpl

public interface DataInstance
extends NamedElement, BaseElement

This object represents this instance of DataDefinition generated when the associated ProcessInstance or FlowNodeInstance is instantiated.

Since:

6.0.0

Version:

6.4.1

Author:

Feng Hui, Celine Souchet

Method Summary

Modifier and Type	Method and Description
String	getClassName() Get the class name of the type of the data defined in DataDefinition.
long	getContainerId() Get the identifier of the element where the data is defined.
String	getContainerType() Get the type of the element where the data is defined.
String	getDescription() Get the description of the data defined in DataDefinition.
Serializable	getValue() Get the value of the data.
Boolean	isTransientData() Is it transient?

Methods inherited from interface org.bonitasoft.engine.bpm.NamedElement

getName

Methods inherited from interface org.bonitasoft.engine.bpm.BaseElement

getId

Method Detail

getDescription

String getDescription()

Get the description of the data defined in DataDefinition.

Returns:

The description of the data.

Since:

6.0.0

See Also:

DescriptionElement.getDescription()

getClassName

String getClassName()

Get the class name of the type of the data defined in DataDefinition.

Returns:

The class name of the type of the data.

Since:

6.0.0

See Also:

DataDefinition.getClassName()

isTransientData

Boolean isTransientData()

Is it transient?

Returns:

true if the data is transient, false otherwise.

Since:

6.0.0

See Also:

DataDefinition.isTransientData()

getValue

Serializable getValue()

Get the value of the data.

Returns:

The value of the data.

Since:

6.0.0

getContainerId

long getContainerId()

Get the identifier of the element where the data is defined. The element can be a ProcessInstance or a FlowNodeInstance.

Returns:

The identifier of the container of the data.

Since:

6.0.0

See Also:

BaseElement.getId(), BaseElement.getId()

getContainerType

String getContainerType()

Get the type of the element where the data is defined. The list of value for this field is :

• PROCESS_INSTANCE
• ACTIVITY_INSTANCE
• MESSAGE_INSTANCE

Returns:

The type of the container of the data.

Since:

6.0.0