com.flowable.dataobject.api.runtime

Interface DataObjectModificationBuilder<T extends DataObjectModificationBuilder,U extends DataObjectInstance>

All Known Subinterfaces:

DatabaseSchemaDataObjectModificationBuilder

All Known Implementing Classes:

DatabaseSchemaDataObjectModificationBuilderImpl

public interface DataObjectModificationBuilder<T extends DataObjectModificationBuilder,U extends DataObjectInstance>

The basic data object modification builder which might be extended with a strongly typed support by the underlying DataObjectDataSource implementation.

Author:

Micha Kiener

Method Summary

Modifier and Type	Method and Description
String	getDefinitionId() Returns the id of the data object definition this modification builder is based on.
String	getLookupId() Returns the external id of the data object to be modified.
U	modify() Persists the modified data object instance.
T	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.
T	value(String valueName, Object value) Generic setter for a data object field value specified by its name and value to be set.

Method Detail

getDefinitionId

String getDefinitionId()

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

Returns:

the id of the data object definition

getLookupId

String getLookupId()

Returns the external id of the data object to be modified.

Returns:

the external id of the data object

modifyFromPayload

T 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.

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

value

T value(String valueName,
        Object value)

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

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

modify

U modify()

Persists the modified data object instance.

Returns:

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