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

Class DataObjectDataSourceImpl

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.datasource.DataObjectDataSourceImpl

All Implemented Interfaces:

DataObjectDataSource

public class DataObjectDataSourceImpl
extends CommonEngineServiceImpl<DataObjectEngineConfiguration>
implements DataObjectDataSource

Author:

Filip Hrisafov

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
DataObjectDataSourceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method	Description
DataObjectInstanceVariableContainer	create(DataObjectInstanceVariableContainerBuilderImpl dataObjectInstanceBuilder)
DataObjectDeletionBuilder	createDataObjectDeletionBuilder()	Create a new data object deletion builder use to delete existing data objects.
DataObjectInstanceVariableContainerBuilder	createDataObjectInstanceBuilder()	Creates a new data object instance builder object used to create new data object instances and persist them.
DataObjectInstanceVariableContainerQuery	createDataObjectInstanceQuery()	Creates a new data object instance query object that can be used for querying data object instances.
DataObjectModificationBuilder	createDataObjectModificationBuilder()	Creates a new data object modification builder used to modify an existing data object with strong type support.
void	deleteDataObjectInstance(String lookupId, String definitionId)	Deletes the specified data object given by its lookup id and specified by the data object definition and model.
DataObjectInstanceVariableContainer	findDataObjectByLookupIdAndDefinitionId(String lookupId, String definitionId)	Lookup a single data object given by its lookup id and definition id.
DataObjectInstanceVariableContainer	findDataObjectByLookupIdAndDefinitionKey(String lookupId, String definitionKey)	Lookup a single data object given by its lookup id and definition key.
String	getDescription()	Returns the optional description for this data source.
String	getId()	Returns the id of this source which must be unique within the system, so there must only be exactly one data source with that id.
String	getName()	Returns the name of this data source which might be used as a label, but never for referencing it.
DataObjectInstanceVariableContainer	modify(DataObjectModificationBuilderImpl modificationBuilder)

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

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

createDataObjectModificationBuilder

Constructor Detail

DataObjectDataSourceImpl

public DataObjectDataSourceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Detail

getId

public String getId()

Description copied from interface: DataObjectDataSource

Returns the id of this source which must be unique within the system, so there must only be exactly one data source with that id.

Specified by:

getId in interface DataObjectDataSource

Returns:

the id of this data source

getName

public String getName()

Description copied from interface: DataObjectDataSource

Returns the name of this data source which might be used as a label, but never for referencing it.

Specified by:

getName in interface DataObjectDataSource

Returns:

the name of this data source

getDescription

public String getDescription()

Description copied from interface: DataObjectDataSource

Returns the optional description for this data source.

Specified by:

getDescription in interface DataObjectDataSource

Returns:

the description of this data source

findDataObjectByLookupIdAndDefinitionId

public DataObjectInstanceVariableContainer findDataObjectByLookupIdAndDefinitionId(String lookupId,
                                                                                   String definitionId)

Description copied from interface: DataObjectDataSource

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

Specified by:

findDataObjectByLookupIdAndDefinitionId in interface DataObjectDataSource

Parameters:

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

definitionId - the data object definition id to load a data object for

Returns:

the data object instance, if found, null otherwise

findDataObjectByLookupIdAndDefinitionKey

public DataObjectInstanceVariableContainer findDataObjectByLookupIdAndDefinitionKey(String lookupId,
                                                                                    String definitionKey)

Description copied from interface: DataObjectDataSource

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

Specified by:

findDataObjectByLookupIdAndDefinitionKey in interface DataObjectDataSource

Parameters:

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

definitionKey - the data object definition key to load a data object for

Returns:

the data object instance, if found, null otherwise

createDataObjectInstanceBuilder

public DataObjectInstanceVariableContainerBuilder createDataObjectInstanceBuilder()

Description copied from interface: DataObjectDataSource

Creates a new data object instance builder object used to create new data object instances and persist them.

Specified by:

createDataObjectInstanceBuilder in interface DataObjectDataSource

Returns:

the data object instance builder object

deleteDataObjectInstance

public void deleteDataObjectInstance(String lookupId,
                                     String definitionId)

Description copied from interface: DataObjectDataSource

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

Specified by:

deleteDataObjectInstance in interface DataObjectDataSource

Parameters:

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

definitionId - the data object definition id to delete an object instance for

createDataObjectModificationBuilder

public DataObjectModificationBuilder createDataObjectModificationBuilder()

Description copied from interface: DataObjectDataSource

Creates a new data object modification builder used to modify an existing data object with strong type support. If needed by the data source implementation, the builder might load and hold the current data object first to allow modified data to be applied directly, specially, if partial updates are not supported as the modification builder might only update partial data of the object.

Specified by:

createDataObjectModificationBuilder in interface DataObjectDataSource

Returns:

the data object modification builder

createDataObjectInstanceQuery

public DataObjectInstanceVariableContainerQuery createDataObjectInstanceQuery()

Description copied from interface: DataObjectDataSource

Creates a new data object instance query object that can be used for querying data object instances.

Specified by:

createDataObjectInstanceQuery in interface DataObjectDataSource

Returns:

the data object query

createDataObjectDeletionBuilder

public DataObjectDeletionBuilder createDataObjectDeletionBuilder()

Description copied from interface: DataObjectDataSource

Create a new data object deletion builder use to delete existing data objects.

Specified by:

createDataObjectDeletionBuilder in interface DataObjectDataSource

Returns:

the data object deletion builder

create

public DataObjectInstanceVariableContainer create(DataObjectInstanceVariableContainerBuilderImpl dataObjectInstanceBuilder)

modify

public DataObjectInstanceVariableContainer modify(DataObjectModificationBuilderImpl modificationBuilder)