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

Class GenericDataObjectInstanceVariableContainerBuilder

java.lang.Object

com.flowable.dataobject.engine.impl.runtime.GenericDataObjectInstanceVariableContainerBuilder

All Implemented Interfaces:

DataObjectInstanceVariableContainerBuilder

public class GenericDataObjectInstanceVariableContainerBuilder
extends Object
implements DataObjectInstanceVariableContainerBuilder

Author:

Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	GenericDataObjectInstanceVariableContainerBuilder.ExecuteCreation

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	accessibleByGroups
protected boolean	accessibleBySet
protected String	accessibleByUser
protected CommandExecutor	commandExecutor
protected DataObjectHandlingContext	context
protected Map<String,Object>	data
protected String	definitionId
protected String	definitionKey
protected String	operation
protected String	tenantId

Constructor Summary

Constructors

Constructor	Description
GenericDataObjectInstanceVariableContainerBuilder(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
DataObjectInstanceVariableContainerBuilder	accessibleByUserOrGroups(String userId, Collection<String> groupKeys)	If set, the permissions to create data object instances are checked against the passed user and groups.
DataObjectInstanceVariableContainer	create()	Creates and persists the new data object instance.
DataObjectInstanceVariableContainerBuilder	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.
DataObjectInstanceVariableContainerBuilder	definitionId(String id)	Set the id of the data object definition the new instance should be based on.
DataObjectInstanceVariableContainerBuilder	definitionKey(String key)	Set the key of the data object definition the new instance should be based on.
Map<String,Object>	getData()
String	getDefinitionId()
String	getDefinitionKey()
String	getTenantId()
DataObjectInstanceVariableContainerBuilder	operation(String operation)	Set the key of the operation that should be used to create the object.
DataObjectInstanceVariableContainerBuilder	tenantId(String tenantId)	Set the tenant id for the new data object.
DataObjectInstanceVariableContainerBuilder	value(String valueName, 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

Methods inherited from interface com.flowable.dataobject.api.runtime.DataObjectInstanceVariableContainerBuilder

accessibleByUser

Field Detail

commandExecutor

protected final CommandExecutor commandExecutor

definitionId

protected String definitionId

definitionKey

protected String definitionKey

tenantId

protected String tenantId

operation

protected String operation

context

protected DataObjectHandlingContext context

data

protected Map<String,Object> data

accessibleByUser

protected String accessibleByUser

accessibleByGroups

protected Collection<String> accessibleByGroups

accessibleBySet

protected boolean accessibleBySet

Constructor Detail

GenericDataObjectInstanceVariableContainerBuilder

public GenericDataObjectInstanceVariableContainerBuilder(CommandExecutor commandExecutor)

Method Detail

definitionId

public DataObjectInstanceVariableContainerBuilder definitionId(String id)

Description copied from interface: DataObjectInstanceVariableContainerBuilder

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.

Specified by:

definitionId in interface DataObjectInstanceVariableContainerBuilder

definitionKey

public DataObjectInstanceVariableContainerBuilder definitionKey(String key)

Description copied from interface: DataObjectInstanceVariableContainerBuilder

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.

Specified by:

definitionKey in interface DataObjectInstanceVariableContainerBuilder

tenantId

public DataObjectInstanceVariableContainerBuilder tenantId(String tenantId)

Description copied from interface: DataObjectInstanceVariableContainerBuilder

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

Specified by:

tenantId in interface DataObjectInstanceVariableContainerBuilder

operation

public DataObjectInstanceVariableContainerBuilder operation(String operation)

Description copied from interface: DataObjectInstanceVariableContainerBuilder

Set the key of the operation that should be used to create the object.

Specified by:

operation in interface DataObjectInstanceVariableContainerBuilder

createFromPayload

public DataObjectInstanceVariableContainerBuilder createFromPayload(DataObjectHandlingContext context)

Description copied from interface: DataObjectInstanceVariableContainerBuilder

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.

Specified by:

createFromPayload in interface DataObjectInstanceVariableContainerBuilder

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

public DataObjectInstanceVariableContainerBuilder value(String valueName,
                                                        Object value)

Description copied from interface: DataObjectInstanceVariableContainerBuilder

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

Specified by:

value in interface DataObjectInstanceVariableContainerBuilder

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

accessibleByUserOrGroups

public DataObjectInstanceVariableContainerBuilder accessibleByUserOrGroups(String userId,
                                                                           Collection<String> groupKeys)

Description copied from interface: DataObjectInstanceVariableContainerBuilder

If set, the permissions to create data object instances are checked against the passed user and groups.

Specified by:

accessibleByUserOrGroups in interface DataObjectInstanceVariableContainerBuilder

create

public DataObjectInstanceVariableContainer create()

Description copied from interface: DataObjectInstanceVariableContainerBuilder

Creates and persists the new data object instance.

Specified by:

create in interface DataObjectInstanceVariableContainerBuilder

Returns:

the newly created data object instance

getDefinitionId

public String getDefinitionId()

Specified by:

getDefinitionId in interface DataObjectInstanceVariableContainerBuilder

getDefinitionKey

public String getDefinitionKey()

Specified by:

getDefinitionKey in interface DataObjectInstanceVariableContainerBuilder

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface DataObjectInstanceVariableContainerBuilder

getData

public Map<String,Object> getData()

Specified by:

getData in interface DataObjectInstanceVariableContainerBuilder