com.flowable.dataobject.api.runtime

Interface DataObjectDeletionBuilder

All Known Implementing Classes:

DataObjectDeletionBuilderImpl, GenericDataObjectDeletionBuilder

public interface DataObjectDeletionBuilder

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

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method and Description
default DataObjectDeletionBuilder	accessibleByUser(String userId)
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.

Method Detail

definitionId

DataObjectDeletionBuilder definitionId(String id)

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.

definitionKey

DataObjectDeletionBuilder definitionKey(String key)

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.

tenantId

DataObjectDeletionBuilder tenantId(String tenantId)

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

dataObjectInstanceId

DataObjectDeletionBuilder dataObjectInstanceId(String dataObjectInstanceId)

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

value

DataObjectDeletionBuilder 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

accessibleByUser

default DataObjectDeletionBuilder accessibleByUser(String userId)

accessibleByUserOrGroups

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

delete

void delete(String operationKey)

Perform a delete operation using the given operation key.