Package com.flowable.dataobject.engine.impl.repository

Class DataObjectRepositoryServiceImpl

java.lang.Object

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

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

com.flowable.dataobject.engine.impl.repository.DataObjectRepositoryServiceImpl

All Implemented Interfaces:

DataObjectRepositoryService

public class DataObjectRepositoryServiceImpl
extends CommonEngineServiceImpl<DataObjectEngineConfiguration>
implements DataObjectRepositoryService

Author:

Joram Barrez, Tijs Rademakers

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

Method Summary

Modifier and Type	Method	Description
DataObjectDefinitionQuery	createDataObjectDefinitionQuery()	Returns a new data object definition query instance to be used when searching for data object definitions.
DataObjectSchemaDefinitionQuery	createDataObjectSchemaDefinitionQuery()
DataObjectDeploymentBuilder	createDeployment()	Starts creating a new deployment
DataObjectDeploymentQuery	createDeploymentQuery()	Query deployments
void	deleteDeployment(String deploymentId)	Deletes the given deployment.
DataObjectDeployment	deploy(DataObjectDeploymentBuilderImpl deploymentBuilder)
DataObjectDefinition	getDataObjectDefinition(String dataObjectDefinitionId)	Returns the specified data object definition given by its id.
DataObjectDefinition	getDataObjectDefinitionByKey(String dataObjectDefinitionKey)	Returns the data object definition with the matching definition key.
DataObjectDefinition	getDataObjectDefinitionByKeyAndTenantId(String dataObjectDefinitionKey, String tenantId)	Returns the data object definition with the matching definition key and tenant id.
DataObjectModel	getDataObjectModel(String dataObjectDefinitionId)	Returns the data object model by definition id.
DataObjectModel	getDataObjectModelByKey(String dataObjectDefinitionKey)	Returns the data object model by definition key.
DataObjectModel	getDataObjectModelByKeyAndTenantId(String dataObjectDefinitionKey, String tenantId)	Returns the data object model by definition key and tenant id.
List<String>	getDeploymentResourceNames(String deploymentId)	Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
MasterDataModel	getMasterDataModel(String dataObjectDefinitionId)	Returns the master data model for the given master data definition id containing the meta information for that master data type.
InputStream	getResourceAsStream(String deploymentId, String resourceName)	Gives access to a deployment resource through a stream of bytes.
void	performDataObjectSchemaDefinitionRollback(String dataObjectSchemaDefinitionId)	Perform the rollback for the schema definition with the given id.
void	performDataObjectSchemaDefinitionUpdate(String dataObjectSchemaDefinitionId)	Perform the update for the schema definition with the given id.

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

DataObjectRepositoryServiceImpl

public DataObjectRepositoryServiceImpl(DataObjectEngineConfiguration engineConfiguration)

Method Details

createDeployment

public DataObjectDeploymentBuilder createDeployment()

Description copied from interface: DataObjectRepositoryService

Starts creating a new deployment

Specified by:

createDeployment in interface DataObjectRepositoryService

getDeploymentResourceNames

public List<String> getDeploymentResourceNames(String deploymentId)

Description copied from interface: DataObjectRepositoryService

Retrieves a list of deployment resources for the given deployment, ordered alphabetically.

Specified by:

getDeploymentResourceNames in interface DataObjectRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

getResourceAsStream

public InputStream getResourceAsStream(String deploymentId,
 String resourceName)

Description copied from interface: DataObjectRepositoryService

Gives access to a deployment resource through a stream of bytes.

Specified by:

getResourceAsStream in interface DataObjectRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

resourceName - name of the resource, cannot be null.

deploy

public DataObjectDeployment deploy(DataObjectDeploymentBuilderImpl deploymentBuilder)

getDataObjectDefinition

public DataObjectDefinition getDataObjectDefinition(String dataObjectDefinitionId)

Description copied from interface: DataObjectRepositoryService

Returns the specified data object definition given by its id.

Specified by:

getDataObjectDefinition in interface DataObjectRepositoryService

Parameters:

dataObjectDefinitionId - the id of the data object definition

Returns:

the data object definition given by its id or null if not found

getDataObjectDefinitionByKey

public DataObjectDefinition getDataObjectDefinitionByKey(String dataObjectDefinitionKey)

Description copied from interface: DataObjectRepositoryService

Returns the data object definition with the matching definition key.

Specified by:

getDataObjectDefinitionByKey in interface DataObjectRepositoryService

Parameters:

dataObjectDefinitionKey - the key of the data object definition

Returns:

the data object definition given by its key or null if not found

getDataObjectDefinitionByKeyAndTenantId

public DataObjectDefinition getDataObjectDefinitionByKeyAndTenantId(String dataObjectDefinitionKey,
 String tenantId)

Description copied from interface: DataObjectRepositoryService

Returns the data object definition with the matching definition key and tenant id.

Specified by:

getDataObjectDefinitionByKeyAndTenantId in interface DataObjectRepositoryService

Parameters:

dataObjectDefinitionKey - the key of the data object definition

tenantId - the tenant ID of the data object definition

Returns:

the data object definition given by its key and tenantId or null if not found

getDataObjectModel

public DataObjectModel getDataObjectModel(String dataObjectDefinitionId)

Description copied from interface: DataObjectRepositoryService

Returns the data object model by definition id.

Specified by:

getDataObjectModel in interface DataObjectRepositoryService

Parameters:

dataObjectDefinitionId - the id of the data object definition

Returns:

the parsed data object model.

getMasterDataModel

public MasterDataModel getMasterDataModel(String dataObjectDefinitionId)

Description copied from interface: DataObjectRepositoryService

Returns the master data model for the given master data definition id containing the meta information for that master data type.

Specified by:

getMasterDataModel in interface DataObjectRepositoryService

Parameters:

dataObjectDefinitionId - the id of the master data definition to return its model

Returns:

the master data model requested

getDataObjectModelByKey

public DataObjectModel getDataObjectModelByKey(String dataObjectDefinitionKey)

Description copied from interface: DataObjectRepositoryService

Returns the data object model by definition key.

Specified by:

getDataObjectModelByKey in interface DataObjectRepositoryService

Parameters:

dataObjectDefinitionKey - the key of the data object definition

Returns:

the parsed data object model.

getDataObjectModelByKeyAndTenantId

public DataObjectModel getDataObjectModelByKeyAndTenantId(String dataObjectDefinitionKey,
 String tenantId)

Description copied from interface: DataObjectRepositoryService

Returns the data object model by definition key and tenant id.

Specified by:

getDataObjectModelByKeyAndTenantId in interface DataObjectRepositoryService

Parameters:

dataObjectDefinitionKey - the key of the data object definition

tenantId - the tenant ID of the data object definition

Returns:

the parsed data object model.

performDataObjectSchemaDefinitionUpdate

public void performDataObjectSchemaDefinitionUpdate(String dataObjectSchemaDefinitionId)

Description copied from interface: DataObjectRepositoryService

Perform the update for the schema definition with the given id.

Specified by:

performDataObjectSchemaDefinitionUpdate in interface DataObjectRepositoryService

Parameters:

dataObjectSchemaDefinitionId - the id of the data object schema definition for which the update should be done

performDataObjectSchemaDefinitionRollback

public void performDataObjectSchemaDefinitionRollback(String dataObjectSchemaDefinitionId)

Description copied from interface: DataObjectRepositoryService

Perform the rollback for the schema definition with the given id.

Specified by:

performDataObjectSchemaDefinitionRollback in interface DataObjectRepositoryService

Parameters:

dataObjectSchemaDefinitionId - the id of the data object schema definition for which the rollback should be done

deleteDeployment

public void deleteDeployment(String deploymentId)

Description copied from interface: DataObjectRepositoryService

Deletes the given deployment.

Specified by:

deleteDeployment in interface DataObjectRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

createDeploymentQuery

public DataObjectDeploymentQuery createDeploymentQuery()

Description copied from interface: DataObjectRepositoryService

Query deployments

Specified by:

createDeploymentQuery in interface DataObjectRepositoryService

createDataObjectDefinitionQuery

public DataObjectDefinitionQuery createDataObjectDefinitionQuery()

Description copied from interface: DataObjectRepositoryService

Returns a new data object definition query instance to be used when searching for data object definitions.

Specified by:

createDataObjectDefinitionQuery in interface DataObjectRepositoryService

Returns:

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

createDataObjectSchemaDefinitionQuery

public DataObjectSchemaDefinitionQuery createDataObjectSchemaDefinitionQuery()

Specified by:

createDataObjectSchemaDefinitionQuery in interface DataObjectRepositoryService

Returns:

A query that can be used to retrieve data object schema definitions.