com.flowable.dataobject.api.runtime

Interface DataObjectInstanceBuilder<T extends DataObjectInstanceBuilder,U extends DataObjectInstance>

All Known Subinterfaces:

DatabaseSchemaDataObjectInstanceBuilder

All Known Implementing Classes:

DatabaseSchemaDataObjectInstanceBuilderImpl

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

The basic data object instance 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
U	create() Creates and persists the new data object instance.
T	createFromPayload(DataObjectHandlingContext context) If an instance builder is used to create a new data object given by the payload sent from a form typically, this method is invoked to create the data object according the given payload data.
T	definitionId(String id) Set the id of the data object definition the new instance should be based on.
T	definitionKey(String key) Set the key of the data object definition the new instance should be based on.
String	getDefinitionId()
String	getDefinitionKey()
String	getLookupId()
String	getTenantId()
T	lookupId(String lookupId) Set the lookup id of the data object instance, if already known.
T	tenantId(String tenantId) Set the tenant id for the new data object.
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

definitionId

T definitionId(String id)

Set the id of the data object definition the new instance should be based on. Must only be provided, if the data object definition key is not set.

definitionKey

T definitionKey(String key)

Set the key of the data object definition the new instance should be based on. If set, the latest definition id is used. The key is ignored, if the definition id is set directly.

tenantId

T tenantId(String tenantId)

Set the tenant id for the new data object. This can be used together with the definition key for the lookup

lookupId

T lookupId(String lookupId)

Set the lookup id of the data object instance, if already known. Most likely it will be set once created and persisted by the underlying data source.

Parameters:

lookupId -

createFromPayload

T createFromPayload(DataObjectHandlingContext context)

If an instance builder is used to create a new data object given by the payload sent from a form typically, this method is invoked to create 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

create

U create()

Creates and persists the new data object instance.

Returns:

the newly created data object instance

getDefinitionId

String getDefinitionId()

getDefinitionKey

String getDefinitionKey()

getTenantId

String getTenantId()

getLookupId

String getLookupId()