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

Class DataObjectRuntimeServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<DataObjectEngineConfiguration>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<DataObjectEngineConfiguration>

com.flowable.dataobject.engine.impl.runtime.DataObjectRuntimeServiceImpl

All Implemented Interfaces:

DataObjectRuntimeService

public class DataObjectRuntimeServiceImpl
extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<DataObjectEngineConfiguration>
implements DataObjectRuntimeService

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor	Description
DataObjectRuntimeServiceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method	Description
void	addGroupIdentityLink(String lookupId, String dataObjectDefinitionKey, String groupId, String identityLinkType)	Involves a group with a data object instance.
void	addUserIdentityLink(String lookupId, String dataObjectDefinitionKey, String userId, String identityLinkType)	Involves a user with a data object instance.
DataObjectDeletionBuilder	createDataObjectDeletionBuilder()	Creates a new generic data object instance deletion builder to delete data objects.
DataObjectInstanceEntityQuery	createDataObjectInstanceEntityQuery()	Returns a data object instance query to be used when searching for data object instances.
DataObjectInstanceVariableContainerQuery	createDataObjectInstanceQuery()	Creates a new generic data object instance query to query data objects.
DataObjectModificationBuilder	createDataObjectModificationBuilder()	Creates a new database schema data object modification builder to modify existing data objects.
DataObjectModificationBuilder	createDataObjectModificationBuilder(String dataObjectDefinitionId)	Creates a new database schema data object modification builder to modify existing data objects.
DataObjectInstanceVariableContainerBuilder	createDataObjectValueInstanceBuilder()	Creates a new generic data object instance builder to create new data objects.
DataObjectInstanceVariableContainerBuilder	createDataObjectValueInstanceBuilderByDefinitionId(String dataObjectDefinitionId)	Creates a new generic data object instance builder to create new data objects.
DataObjectInstanceVariableContainerBuilder	createDataObjectValueInstanceBuilderByDefinitionKey(String dataObjectDefinitionKey)	Creates a new generic data object instance builder to create new data objects.
DataObjectInstanceVariableContainerBuilder	createDataObjectValueInstanceBuilderByDefinitionKeyAndTenantId(String dataObjectDefinitionKey, String tenantId)	Creates a new generic data object instance builder to create new data objects.
MasterDataInstance	createMasterDataInstance(MasterDataInstanceBuilderImpl masterDataInstanceBuilder)
MasterDataInstanceBuilder	createMasterDataInstanceBuilder()	Creates a builder to add a new master data instance
MasterDataInstanceImportBuilder	createMasterDataInstanceImportBuilder()	Creates a loader to add a new master data instances from a document.
MasterDataInstanceQuery	createMasterDataInstanceQuery()	Returns a master data instance query to be used when searching for master data instances.
MasterDataInstanceUpdateBuilder	createMasterDataInstanceUpdateBuilder(String masterDataInstanceId)	Creates a builder to update a master data instance
void	deleteDataObject(String lookupId, String dataObjectDefinitionId)	Deletes the specified data object given by its lookup id and data object definition.
void	deleteDataObjectVariablesByInstanceId(String dataInstanceId)	Deletes data object variables by master instance id
void	deleteGroupIdentityLink(String lookupId, String dataObjectDefinitionKey, String groupId, String identityLinkType)	Removes the association between a group and a data object instance for the given identityLinkType.
void	deleteMasterDataInstanceById(String instanceId)	Deletes one master data instance by instance id
void	deleteMasterDataInstancesByDefinitionId(String dataObjectDefinitionId)	Deletes master data instances by data object definition id
void	deleteMasterDataInstanceVariable(String instanceId, String variableName)	Deletes one master data instance by instance id
void	deleteUserIdentityLink(String lookupId, String dataObjectDefinitionKey, String userId, String identityLinkType)	Removes the association between a user and a data object instance for the given identityLinkType.
DataObjectInstanceVariableContainer	findDataObjectValueByDataObjectInstanceId(String instanceId)	Lookup a single data object given by its instance id.
DataObjectInstanceVariableContainer	findDataObjectValueByLookupIdAndDefinitionId(String lookupId, String dataObjectDefinitionId)	Lookup a single data object given by its lookup id and definition id.
DataObjectInstanceVariableContainer	findDataObjectValueByLookupIdAndDefinitionKey(String lookupId, String dataObjectDefinitionKey)	Lookup a single data object given by its lookup id and definition key.
DataObjectInstanceVariableContainer	findDataObjectValueByLookupIdAndDefinitionKey(String lookupId, String dataObjectDefinitionKey, String tenantId)	Lookup a single data object given by its lookup id and definition key.
protected DataObjectDefinition	getDataObjectDefinitionById(String dataObjectDefinitionId)
protected DataObjectDefinition	getDataObjectDefinitionByKey(String dataObjectDefinitionKey)
protected DataObjectDefinition	getDataObjectDefinitionByKeyAndTenantId(String dataObjectDefinitionKey, String tenantId)
protected DataObjectModel	getDataObjectModelById(String dataObjectDefinitionId)
protected DataObjectModel	getDataObjectModelByKey(String dataObjectDefinitionKey)
protected DataObjectModel	getDataObjectModelByKeyAndTenantId(String dataObjectDefinitionKey, String tenantId)
protected DataObjectRepositoryService	getDataObjectRepositoryService()
DataObjectDataSource	getDataSource(String dataSourceId)	Returns the data source given its id.
List<org.flowable.identitylink.api.IdentityLink>	getIdentityLinksForDataObjectInstance(String lookupId, String dataObjectDefinitionKey)	Retrieves the IdentityLinks associated with the given data object instance.
Map<String,Object>	getMasterDataInstanceVariables(String masterDataInstanceId)	Get the variables for the master data instance with the provided id
void	loadMasterDataInstanceData(String data, String dataObjectDefinitionId)	Loads master data instance data into the data object engine
MasterDataInstance	saveMasterDataInstance(MasterDataInstance masterDataInstance)	Saves an updated master data instance
void	saveMasterDataInstanceVariables(String masterDataInstanceId, Map<String,Object> variablesToSet)	Save a map of variables for a masterDataInstanceId
MasterDataInstance	updateMasterDataInstance(MasterDataInstanceUpdateBuilderImpl masterDataInstanceUpdateBuilder)

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DataObjectRuntimeServiceImpl

public DataObjectRuntimeServiceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Details

findDataObjectValueByDataObjectInstanceId

public DataObjectInstanceVariableContainer findDataObjectValueByDataObjectInstanceId(String instanceId)

Description copied from interface: DataObjectRuntimeService

Lookup a single data object given by its instance id.

Specified by:

findDataObjectValueByDataObjectInstanceId in interface DataObjectRuntimeService

Parameters:

instanceId - the instance id of the data object to be returned

Returns:

the data object instance, if found, null otherwise

findDataObjectValueByLookupIdAndDefinitionKey

public DataObjectInstanceVariableContainer findDataObjectValueByLookupIdAndDefinitionKey(String lookupId,
 String dataObjectDefinitionKey)

Description copied from interface: DataObjectRuntimeService

Lookup a single data object given by its lookup id and definition key.

Specified by:

findDataObjectValueByLookupIdAndDefinitionKey in interface DataObjectRuntimeService

Parameters:

lookupId - the lookup id of the data object to be returned

dataObjectDefinitionKey - the key of the data object definition to return a data object instance for

Returns:

the data object instance, if found, null otherwise

findDataObjectValueByLookupIdAndDefinitionKey

public DataObjectInstanceVariableContainer findDataObjectValueByLookupIdAndDefinitionKey(String lookupId,
 String dataObjectDefinitionKey,
 String tenantId)

Description copied from interface: DataObjectRuntimeService

Lookup a single data object given by its lookup id and definition key.

Specified by:

findDataObjectValueByLookupIdAndDefinitionKey in interface DataObjectRuntimeService

Parameters:

lookupId - the lookup id of the data object to be returned

dataObjectDefinitionKey - the key of the data object definition to return a data object instance for

tenantId - the tenant id to return a data object instance for

Returns:

the data object instance, if found, null otherwise

findDataObjectValueByLookupIdAndDefinitionId

public DataObjectInstanceVariableContainer findDataObjectValueByLookupIdAndDefinitionId(String lookupId,
 String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Lookup a single data object given by its lookup id and definition id.

Specified by:

findDataObjectValueByLookupIdAndDefinitionId in interface DataObjectRuntimeService

Parameters:

lookupId - the lookup id of the data object to be returned

dataObjectDefinitionId - the id of the data object definition to return a data object instance for

Returns:

the data object instance, if found, null otherwise

createDataObjectValueInstanceBuilder

public DataObjectInstanceVariableContainerBuilder createDataObjectValueInstanceBuilder()

Description copied from interface: DataObjectRuntimeService

Creates a new generic data object instance builder to create new data objects.

Specified by:

createDataObjectValueInstanceBuilder in interface DataObjectRuntimeService

Returns:

the data object instance builder

createDataObjectValueInstanceBuilderByDefinitionKey

public DataObjectInstanceVariableContainerBuilder createDataObjectValueInstanceBuilderByDefinitionKey(String dataObjectDefinitionKey)

Description copied from interface: DataObjectRuntimeService

Creates a new generic data object instance builder to create new data objects.

Specified by:

createDataObjectValueInstanceBuilderByDefinitionKey in interface DataObjectRuntimeService

Parameters:

dataObjectDefinitionKey - the key of the data object definition a new instance should be created for

Returns:

the data object instance builder

createDataObjectValueInstanceBuilderByDefinitionKeyAndTenantId

public DataObjectInstanceVariableContainerBuilder createDataObjectValueInstanceBuilderByDefinitionKeyAndTenantId(String dataObjectDefinitionKey,
 String tenantId)

Description copied from interface: DataObjectRuntimeService

Creates a new generic data object instance builder to create new data objects.

Specified by:

createDataObjectValueInstanceBuilderByDefinitionKeyAndTenantId in interface DataObjectRuntimeService

Parameters:

dataObjectDefinitionKey - the key of the data object definition a new instance should be created for

tenantId - the tenant of the data object definition

Returns:

the data object instance builder

createDataObjectValueInstanceBuilderByDefinitionId

public DataObjectInstanceVariableContainerBuilder createDataObjectValueInstanceBuilderByDefinitionId(String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Creates a new generic data object instance builder to create new data objects.

Specified by:

createDataObjectValueInstanceBuilderByDefinitionId in interface DataObjectRuntimeService

Parameters:

dataObjectDefinitionId - the id of the data object definition a new instance should be created for

Returns:

the data object instance builder

createDataObjectModificationBuilder

public DataObjectModificationBuilder createDataObjectModificationBuilder()

Description copied from interface: DataObjectRuntimeService

Creates a new database schema data object modification builder to modify existing data objects. As we already know the data object to be modified, this method will get a modification builder through the data source handling this specific data object.

Specified by:

createDataObjectModificationBuilder in interface DataObjectRuntimeService

Returns:

the data object modification builder

createDataObjectModificationBuilder

public DataObjectModificationBuilder createDataObjectModificationBuilder(String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Creates a new database schema data object modification builder to modify existing data objects. As we already know the data object to be modified, this method will get a modification builder through the data source handling this specific data object.

Specified by:

createDataObjectModificationBuilder in interface DataObjectRuntimeService

Parameters:

dataObjectDefinitionId - the id of the data object definition for the data object to be modified

Returns:

the data object modification builder

createDataObjectInstanceQuery

public DataObjectInstanceVariableContainerQuery createDataObjectInstanceQuery()

Description copied from interface: DataObjectRuntimeService

Creates a new generic data object instance query to query data objects.

Specified by:

createDataObjectInstanceQuery in interface DataObjectRuntimeService

Returns:

the data object query

createDataObjectDeletionBuilder

public DataObjectDeletionBuilder createDataObjectDeletionBuilder()

Description copied from interface: DataObjectRuntimeService

Creates a new generic data object instance deletion builder to delete data objects.

Specified by:

createDataObjectDeletionBuilder in interface DataObjectRuntimeService

Returns:

the data object deletion builder

deleteDataObject

public void deleteDataObject(String lookupId,
 String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Deletes the specified data object given by its lookup id and data object definition.

Specified by:

deleteDataObject in interface DataObjectRuntimeService

Parameters:

lookupId - the lookup id of the data object to be deleted

dataObjectDefinitionId - the id of the data object definition the data object is specified with

getIdentityLinksForDataObjectInstance

public List<org.flowable.identitylink.api.IdentityLink> getIdentityLinksForDataObjectInstance(String lookupId,
 String dataObjectDefinitionKey)

Description copied from interface: DataObjectRuntimeService

Retrieves the IdentityLinks associated with the given data object instance. Such an IdentityLink informs how a certain user is involved with a data object instance

Specified by:

getIdentityLinksForDataObjectInstance in interface DataObjectRuntimeService

addUserIdentityLink

public void addUserIdentityLink(String lookupId,
 String dataObjectDefinitionKey,
 String userId,
 String identityLinkType)

Description copied from interface: DataObjectRuntimeService

Involves a user with a data object instance. The type of identity link is defined by the given identityLinkType.

Specified by:

addUserIdentityLink in interface DataObjectRuntimeService

Parameters:

lookupId - id of the lookup id, cannot be null.

dataObjectDefinitionKey - the key of the data object definition key

userId - id of the involved user, cannot be null.

identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).

addGroupIdentityLink

public void addGroupIdentityLink(String lookupId,
 String dataObjectDefinitionKey,
 String groupId,
 String identityLinkType)

Description copied from interface: DataObjectRuntimeService

Involves a group with a data object instance. The type of identity link is defined by the given identityLinkType.

Specified by:

addGroupIdentityLink in interface DataObjectRuntimeService

Parameters:

lookupId - id of the lookup id, cannot be null.

dataObjectDefinitionKey - the key of the data object definition key

groupId - id of the involved group, cannot be null.

identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).

deleteUserIdentityLink

public void deleteUserIdentityLink(String lookupId,
 String dataObjectDefinitionKey,
 String userId,
 String identityLinkType)

Description copied from interface: DataObjectRuntimeService

Removes the association between a user and a data object instance for the given identityLinkType.

Specified by:

deleteUserIdentityLink in interface DataObjectRuntimeService

Parameters:

lookupId - id of the lookup id, cannot be null.

dataObjectDefinitionKey - the key of the data object definition key

userId - id of the involved user, cannot be null.

identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).

deleteGroupIdentityLink

public void deleteGroupIdentityLink(String lookupId,
 String dataObjectDefinitionKey,
 String groupId,
 String identityLinkType)

Description copied from interface: DataObjectRuntimeService

Removes the association between a group and a data object instance for the given identityLinkType.

Specified by:

deleteGroupIdentityLink in interface DataObjectRuntimeService

Parameters:

lookupId - id of the lookup id, cannot be null.

dataObjectDefinitionKey - the key of the data object definition key

groupId - id of the involved group, cannot be null.

identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).

getDataSource

public DataObjectDataSource getDataSource(String dataSourceId)

Description copied from interface: DataObjectRuntimeService

Returns the data source given its id.

Specified by:

getDataSource in interface DataObjectRuntimeService

Parameters:

dataSourceId - the id of the data source to be returned

Returns:

the data source

createDataObjectInstanceEntityQuery

public DataObjectInstanceEntityQuery createDataObjectInstanceEntityQuery()

Description copied from interface: DataObjectRuntimeService

Returns a data object instance query to be used when searching for data object instances.

Specified by:

createDataObjectInstanceEntityQuery in interface DataObjectRuntimeService

Returns:

the query instance used to specify the data object instance query terms

loadMasterDataInstanceData

public void loadMasterDataInstanceData(String data,
 String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Loads master data instance data into the data object engine

Specified by:

loadMasterDataInstanceData in interface DataObjectRuntimeService

createMasterDataInstanceQuery

public MasterDataInstanceQuery createMasterDataInstanceQuery()

Description copied from interface: DataObjectRuntimeService

Returns a master data instance query to be used when searching for master data instances.

Specified by:

createMasterDataInstanceQuery in interface DataObjectRuntimeService

Returns:

the query instance used to specify the master data instance query terms

createMasterDataInstanceBuilder

public MasterDataInstanceBuilder createMasterDataInstanceBuilder()

Description copied from interface: DataObjectRuntimeService

Creates a builder to add a new master data instance

Specified by:

createMasterDataInstanceBuilder in interface DataObjectRuntimeService

Returns:

the master data instance builder

createMasterDataInstanceUpdateBuilder

public MasterDataInstanceUpdateBuilder createMasterDataInstanceUpdateBuilder(String masterDataInstanceId)

Description copied from interface: DataObjectRuntimeService

Creates a builder to update a master data instance

Specified by:

createMasterDataInstanceUpdateBuilder in interface DataObjectRuntimeService

Returns:

the master data instance builder

createMasterDataInstanceImportBuilder

public MasterDataInstanceImportBuilder createMasterDataInstanceImportBuilder()

Description copied from interface: DataObjectRuntimeService

Creates a loader to add a new master data instances from a document.

Specified by:

createMasterDataInstanceImportBuilder in interface DataObjectRuntimeService

Returns:

the master data instance loader

getMasterDataInstanceVariables

public Map<String,Object> getMasterDataInstanceVariables(String masterDataInstanceId)

Description copied from interface: DataObjectRuntimeService

Get the variables for the master data instance with the provided id

Specified by:

getMasterDataInstanceVariables in interface DataObjectRuntimeService

Returns:

the master data instance variables

saveMasterDataInstance

public MasterDataInstance saveMasterDataInstance(MasterDataInstance masterDataInstance)

Description copied from interface: DataObjectRuntimeService

Saves an updated master data instance

Specified by:

saveMasterDataInstance in interface DataObjectRuntimeService

Returns:

the updated master data instance

deleteMasterDataInstancesByDefinitionId

public void deleteMasterDataInstancesByDefinitionId(String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Deletes master data instances by data object definition id

Specified by:

deleteMasterDataInstancesByDefinitionId in interface DataObjectRuntimeService

deleteMasterDataInstanceById

public void deleteMasterDataInstanceById(String instanceId)

Description copied from interface: DataObjectRuntimeService

Deletes one master data instance by instance id

Specified by:

deleteMasterDataInstanceById in interface DataObjectRuntimeService

deleteMasterDataInstanceVariable

public void deleteMasterDataInstanceVariable(String instanceId,
 String variableName)

Description copied from interface: DataObjectRuntimeService

Deletes one master data instance by instance id

Specified by:

deleteMasterDataInstanceVariable in interface DataObjectRuntimeService

deleteDataObjectVariablesByInstanceId

public void deleteDataObjectVariablesByInstanceId(String dataInstanceId)

Description copied from interface: DataObjectRuntimeService

Deletes data object variables by master instance id

Specified by:

deleteDataObjectVariablesByInstanceId in interface DataObjectRuntimeService

saveMasterDataInstanceVariables

public void saveMasterDataInstanceVariables(String masterDataInstanceId,
 Map<String,Object> variablesToSet)

Description copied from interface: DataObjectRuntimeService

Save a map of variables for a masterDataInstanceId

Specified by:

saveMasterDataInstanceVariables in interface DataObjectRuntimeService

createMasterDataInstance

public MasterDataInstance createMasterDataInstance(MasterDataInstanceBuilderImpl masterDataInstanceBuilder)

updateMasterDataInstance

public MasterDataInstance updateMasterDataInstance(MasterDataInstanceUpdateBuilderImpl masterDataInstanceUpdateBuilder)

getDataObjectDefinitionById

protected DataObjectDefinition getDataObjectDefinitionById(String dataObjectDefinitionId)

getDataObjectDefinitionByKey

protected DataObjectDefinition getDataObjectDefinitionByKey(String dataObjectDefinitionKey)

getDataObjectDefinitionByKeyAndTenantId

protected DataObjectDefinition getDataObjectDefinitionByKeyAndTenantId(String dataObjectDefinitionKey,
 String tenantId)

getDataObjectModelById

protected DataObjectModel getDataObjectModelById(String dataObjectDefinitionId)

getDataObjectModelByKey

protected DataObjectModel getDataObjectModelByKey(String dataObjectDefinitionKey)

getDataObjectModelByKeyAndTenantId

protected DataObjectModel getDataObjectModelByKeyAndTenantId(String dataObjectDefinitionKey,
 String tenantId)

getDataObjectRepositoryService

protected DataObjectRepositoryService getDataObjectRepositoryService()