Package com.flowable.dataobject.engine.impl.runtime.datasource

Class DataObjectModificationBuilderImpl

java.lang.Object

com.flowable.dataobject.engine.impl.runtime.datasource.DataObjectModificationBuilderImpl

All Implemented Interfaces:

DataObjectModificationBuilder

public class DataObjectModificationBuilderImpl
extends java.lang.Object
implements DataObjectModificationBuilder

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected DataObjectDataSourceImpl	dataObjectDataSource
protected java.lang.String	definitionId
protected java.util.Map<java.lang.String,java.lang.Object>	modificationData
protected java.util.Map<java.lang.String,java.lang.Object>	originalData

Constructor Summary

Constructors

Constructor	Description
DataObjectModificationBuilderImpl(DataObjectDataSourceImpl dataObjectDataSource, java.lang.String definitionId)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefinitionId()	Returns the id of the data object definition this modification builder is based on.
java.util.Map<java.lang.String,java.lang.Object>	getModificationData()
java.util.Map<java.lang.String,java.lang.Object>	getOriginalData()
DataObjectInstanceVariableContainer	modify()	Persists the modified data object instance.
DataObjectModificationBuilder	modifyFromPayload(DataObjectHandlingContext context)	If a modification builder is used to modify a data object given by the payload sent from a form typically, this method is invoked to modify the data object according the given payload data.
DataObjectModificationBuilder	originalValue(java.lang.String valueName, java.lang.Object value)	Generic setter for a data object field value specified by its name and value to be set.
DataObjectModificationBuilder	value(java.lang.String valueName, java.lang.Object value)	Generic setter for a data object field value specified by its name and value to be set.

Methods inherited from class java.lang.Object

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

Field Detail

dataObjectDataSource

protected final DataObjectDataSourceImpl dataObjectDataSource

definitionId

protected final java.lang.String definitionId

modificationData

protected final java.util.Map<java.lang.String,java.lang.Object> modificationData

originalData

protected final java.util.Map<java.lang.String,java.lang.Object> originalData

Constructor Detail

DataObjectModificationBuilderImpl

public DataObjectModificationBuilderImpl(DataObjectDataSourceImpl dataObjectDataSource,
                                         java.lang.String definitionId)

Method Detail

value

public DataObjectModificationBuilder value(java.lang.String valueName,
                                           java.lang.Object value)

Description copied from interface: DataObjectModificationBuilder

Generic setter for a data object field value specified by its name and value to be set.

Specified by:

value in interface DataObjectModificationBuilder

Parameters:

valueName - the name of the data object field to set a value

value - the value to be set

Returns:

the builder instance for method chaining

originalValue

public DataObjectModificationBuilder originalValue(java.lang.String valueName,
                                                   java.lang.Object value)

Description copied from interface: DataObjectModificationBuilder

Generic setter for a data object field value specified by its name and value to be set.

Specified by:

originalValue in interface DataObjectModificationBuilder

Parameters:

valueName - the name of the data object field to set a value

value - the value to be set

Returns:

the builder instance for method chaining

modifyFromPayload

public DataObjectModificationBuilder modifyFromPayload(DataObjectHandlingContext context)

Description copied from interface: DataObjectModificationBuilder

If a modification builder is used to modify a data object given by the payload sent from a form typically, this method is invoked to modify the data object according the given payload data.

Specified by:

modifyFromPayload in interface DataObjectModificationBuilder

Parameters:

context - the data object context containing the data and full payload and further information for parsing the content into the data object

Returns:

the builder instance for method chaining

modify

public DataObjectInstanceVariableContainer modify()

Description copied from interface: DataObjectModificationBuilder

Persists the modified data object instance.

Specified by:

modify in interface DataObjectModificationBuilder

Returns:

the modified data object instance which might be the very same or actually a new one returned by the data source

getDefinitionId

public java.lang.String getDefinitionId()

Description copied from interface: DataObjectModificationBuilder

Returns the id of the data object definition this modification builder is based on.

Specified by:

getDefinitionId in interface DataObjectModificationBuilder

Returns:

the id of the data object definition

getModificationData

public java.util.Map<java.lang.String,java.lang.Object> getModificationData()

Specified by:

getModificationData in interface DataObjectModificationBuilder

getOriginalData

public java.util.Map<java.lang.String,java.lang.Object> getOriginalData()

Specified by:

getOriginalData in interface DataObjectModificationBuilder