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

Class GenericDataObjectDeletionBuilder

java.lang.Object

com.flowable.dataobject.engine.impl.runtime.GenericDataObjectDeletionBuilder

All Implemented Interfaces:

DataObjectDeletionBuilder

public class GenericDataObjectDeletionBuilder
extends Object
implements DataObjectDeletionBuilder

Author:

Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	GenericDataObjectDeletionBuilder.ExecuteDeletion

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	accessibleByGroups
protected String	accessibleByUser
protected CommandExecutor	commandExecutor
protected Map<String,Object>	data
protected String	dataObjectInstanceId
protected String	definitionId
protected String	definitionKey
protected String	tenantId

Constructor Summary

Constructors

Constructor	Description
GenericDataObjectDeletionBuilder(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
DataObjectDeletionBuilder	accessibleByUserOrGroups(String userId, Collection<String> groupKeys)
DataObjectDeletionBuilder	dataObjectInstanceId(String dataObjectInstanceId)	Set the id for data object instance.
DataObjectDeletionBuilder	definitionId(String id)	Set the id of the data object definition the delete operation should be based on.
DataObjectDeletionBuilder	definitionKey(String key)	Set the key of the data object definition the delete operation should be based on.
void	delete(String operationKey)	Perform a delete operation using the given operation key.
DataObjectDeletionBuilder	tenantId(String tenantId)	Set the tenant id for data object definition.
DataObjectDeletionBuilder	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.DataObjectDeletionBuilder

accessibleByUser

Field Detail

commandExecutor

protected final CommandExecutor commandExecutor

definitionId

protected String definitionId

definitionKey

protected String definitionKey

tenantId

protected String tenantId

dataObjectInstanceId

protected String dataObjectInstanceId

data

protected Map<String,Object> data

accessibleByUser

protected String accessibleByUser

accessibleByGroups

protected Collection<String> accessibleByGroups

Constructor Detail

GenericDataObjectDeletionBuilder

public GenericDataObjectDeletionBuilder(CommandExecutor commandExecutor)

Method Detail

definitionId

public DataObjectDeletionBuilder definitionId(String id)

Description copied from interface: DataObjectDeletionBuilder

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

Specified by:

definitionId in interface DataObjectDeletionBuilder

definitionKey

public DataObjectDeletionBuilder definitionKey(String key)

Description copied from interface: DataObjectDeletionBuilder

Set the key of the data object definition the delete operation 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 DataObjectDeletionBuilder

tenantId

public DataObjectDeletionBuilder tenantId(String tenantId)

Description copied from interface: DataObjectDeletionBuilder

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

Specified by:

tenantId in interface DataObjectDeletionBuilder

dataObjectInstanceId

public DataObjectDeletionBuilder dataObjectInstanceId(String dataObjectInstanceId)

Description copied from interface: DataObjectDeletionBuilder

Set the id for data object instance. This id will be used to delete the data object instance with the default delete method

Specified by:

dataObjectInstanceId in interface DataObjectDeletionBuilder

accessibleByUserOrGroups

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

Specified by:

accessibleByUserOrGroups in interface DataObjectDeletionBuilder

value

public DataObjectDeletionBuilder value(String valueName,
                                       Object value)

Description copied from interface: DataObjectDeletionBuilder

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

Specified by:

value in interface DataObjectDeletionBuilder

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

delete

public void delete(String operationKey)

Description copied from interface: DataObjectDeletionBuilder

Perform a delete operation using the given operation key.

Specified by:

delete in interface DataObjectDeletionBuilder