com.flowable.dataobject.engine.impl.runtime

Class DataObjectRuntimeServiceImpl

java.lang.Object

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

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 and Description
DataObjectRuntimeServiceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method and Description
DataObjectInstanceBuilder<?,DataObjectInstance>	createDataObjectInstanceBuilderByDefinitionId(String dataObjectDefinitionId) Creates a new generic data object instance builder to create new data objects.
DataObjectInstanceBuilder<?,DataObjectInstance>	createDataObjectInstanceBuilderByDefinitionKey(String dataObjectDefinitionKey) Creates a new generic data object instance builder to create new data objects.
DataObjectInstanceBuilder<?,DataObjectInstance>	createDataObjectInstanceBuilderByDefinitionKeyAndTenantId(String dataObjectDefinitionKey, String tenantId) Creates a new generic data object instance builder to create new data objects.
DataObjectInstanceQuery<?,DataObjectInstance>	createDataObjectInstanceQueryByDefinitionId(String dataObjectDefinitionId) Creates a new data object instance query object used to define a query returning data object instances.
DataObjectInstanceQuery<?,DataObjectInstance>	createDataObjectInstanceQueryByDefinitionKey(String dataObjectDefinitionKey) Creates a new data object instance query object used to define a query returning data object instances.
DataObjectModificationBuilder<?,DataObjectInstance>	createDataObjectModificationBuilder(String lookupId, String dataObjectDefinitionId) Creates a new generic data object modification builder to modify existing data objects.
MasterDataInstance	createMasterDataInstance(MasterDataInstanceBuilderImpl masterDataInstanceBuilder)
MasterDataInstanceBuilder	createMasterDataInstanceBuilder() Creates a builder to add a new master data instance
MasterDataInstanceQuery	createMasterDataInstanceQuery() Returns a master data instance query to be used when searching for master data instances.
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	deleteMasterDataInstancesByDefinitionId(String dataObjectDefinitionId) Deletes master data instances by data object definition id
DataObjectInstance	findDataObjectByLookupIdAndDefinitionId(String lookupId, String dataObjectDefinitionId) Lookup a single data object given by its lookup id and definition id.
DataObjectInstance	findDataObjectByLookupIdAndDefinitionKey(String lookupId, String dataObjectDefinitionKey) Lookup a single data object given by its lookup id and definition key.
protected DataObjectDefinition	getDataObjectDefinitionById(String dataObjectDefinitionId)
protected DataObjectDefinition	getDataObjectDefinitionByKey(String dataObjectDefinitionKey)
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.
DataObjectDataSource	getDataSourceByDataObjectDefinitionId(String dataObjectDefinitionId) Returns the data source handling the specified data object definition given by its id.
DataObjectDataSource	getDataSourceByDataObjectDefinitionKey(String dataObjectDefinitionKey) Returns the data source handling the specified data object definition given by its key.
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

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 Detail

DataObjectRuntimeServiceImpl

public DataObjectRuntimeServiceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Detail

findDataObjectByLookupIdAndDefinitionKey

public DataObjectInstance findDataObjectByLookupIdAndDefinitionKey(String lookupId,
                                                                   String dataObjectDefinitionKey)

Description copied from interface: DataObjectRuntimeService

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

Specified by:

findDataObjectByLookupIdAndDefinitionKey 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

findDataObjectByLookupIdAndDefinitionId

public DataObjectInstance findDataObjectByLookupIdAndDefinitionId(String lookupId,
                                                                  String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

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

Specified by:

findDataObjectByLookupIdAndDefinitionId 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

createDataObjectInstanceQueryByDefinitionKey

public DataObjectInstanceQuery<?,DataObjectInstance> createDataObjectInstanceQueryByDefinitionKey(String dataObjectDefinitionKey)

Description copied from interface: DataObjectRuntimeService

Creates a new data object instance query object used to define a query returning data object instances.

Specified by:

createDataObjectInstanceQueryByDefinitionKey in interface DataObjectRuntimeService

Parameters:

dataObjectDefinitionKey - the key of the data object definition to determine the data source to create a new query object

Returns:

the data object instance query builder object

createDataObjectInstanceQueryByDefinitionId

public DataObjectInstanceQuery<?,DataObjectInstance> createDataObjectInstanceQueryByDefinitionId(String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Creates a new data object instance query object used to define a query returning data object instances.

Specified by:

createDataObjectInstanceQueryByDefinitionId in interface DataObjectRuntimeService

Parameters:

dataObjectDefinitionId - the id of the data object definition to determine the data source to create a new query object

Returns:

the data object instance query builder object

createDataObjectInstanceBuilderByDefinitionKey

public DataObjectInstanceBuilder<?,DataObjectInstance> createDataObjectInstanceBuilderByDefinitionKey(String dataObjectDefinitionKey)

Description copied from interface: DataObjectRuntimeService

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

Specified by:

createDataObjectInstanceBuilderByDefinitionKey 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

createDataObjectInstanceBuilderByDefinitionKeyAndTenantId

public DataObjectInstanceBuilder<?,DataObjectInstance> createDataObjectInstanceBuilderByDefinitionKeyAndTenantId(String dataObjectDefinitionKey,
                                                                                                                 String tenantId)

Description copied from interface: DataObjectRuntimeService

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

Specified by:

createDataObjectInstanceBuilderByDefinitionKeyAndTenantId 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

createDataObjectInstanceBuilderByDefinitionId

public DataObjectInstanceBuilder<?,DataObjectInstance> createDataObjectInstanceBuilderByDefinitionId(String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

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

Specified by:

createDataObjectInstanceBuilderByDefinitionId 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<?,DataObjectInstance> createDataObjectModificationBuilder(String lookupId,
                                                                                               String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Creates a new generic 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:

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

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

Returns:

the data object modification 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

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

getDataSourceByDataObjectDefinitionKey

public DataObjectDataSource getDataSourceByDataObjectDefinitionKey(String dataObjectDefinitionKey)

Description copied from interface: DataObjectRuntimeService

Returns the data source handling the specified data object definition given by its key.

Specified by:

getDataSourceByDataObjectDefinitionKey in interface DataObjectRuntimeService

Parameters:

dataObjectDefinitionKey - the key of the data object definition to lookup its data source

Returns:

the data source handling the given data object definition

getDataSourceByDataObjectDefinitionId

public DataObjectDataSource getDataSourceByDataObjectDefinitionId(String dataObjectDefinitionId)

Description copied from interface: DataObjectRuntimeService

Returns the data source handling the specified data object definition given by its id.

Specified by:

getDataSourceByDataObjectDefinitionId in interface DataObjectRuntimeService

Parameters:

dataObjectDefinitionId - the id of the data object definition to lookup its data source

Returns:

the data source handling the given data object definition

getDataObjectDefinitionById

protected DataObjectDefinition getDataObjectDefinitionById(String dataObjectDefinitionId)

getDataObjectDefinitionByKey

protected DataObjectDefinition getDataObjectDefinitionByKey(String dataObjectDefinitionKey)

getDataObjectModelById

protected DataObjectModel getDataObjectModelById(String dataObjectDefinitionId)

getDataObjectModelByKey

protected DataObjectModel getDataObjectModelByKey(String dataObjectDefinitionKey)

getDataObjectModelByKeyAndTenantId

protected DataObjectModel getDataObjectModelByKeyAndTenantId(String dataObjectDefinitionKey,
                                                             String tenantId)

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

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

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

createMasterDataInstance

public MasterDataInstance createMasterDataInstance(MasterDataInstanceBuilderImpl masterDataInstanceBuilder)

getDataObjectRepositoryService

protected DataObjectRepositoryService getDataObjectRepositoryService()