com.flowable.dataobject.api.repository

Interface DataObjectRepositoryService

All Known Implementing Classes:

DataObjectRepositoryServiceImpl

public interface DataObjectRepositoryService

The main service interface for the master data management.

Author:

Micha Kiener

Method Summary

Modifier and Type	Method and Description
String	convertDataObjectModelToJson(String dataObjectDefinitionId)
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.
DataObjectDefinition	getDataObjectDefinition(String dataObjectDefinitionId) Returns the specified data object definition given by its id.
DataObjectDefinition	getDataObjectDefinitionByKey(String dataObjectDefinitionKey)
DataObjectDefinition	getDataObjectDefinitionByKeyAndTenantId(String dataObjectDefinitionKey, String tenantId)
DataObjectModel	getDataObjectModel(String dataObjectDefinitionId)
DataObjectModel	getDataObjectModelByKey(String dataObjectDefinitionKey)
DataObjectModel	getDataObjectModelByKeyAndTenantId(String dataObjectDefinitionKey, String tenantId)
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.

Method Detail

createDeployment

DataObjectDeploymentBuilder createDeployment()

Starts creating a new deployment

getDeploymentResourceNames

List<String> getDeploymentResourceNames(String deploymentId)

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

Parameters:

deploymentId - id of the deployment, cannot be null.

getResourceAsStream

InputStream getResourceAsStream(String deploymentId,
                                String resourceName)

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

Parameters:

deploymentId - id of the deployment, cannot be null.

resourceName - name of the resource, cannot be null.

Throws:

FlowableObjectNotFoundException - when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.

createDataObjectDefinitionQuery

DataObjectDefinitionQuery createDataObjectDefinitionQuery()

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

Returns:

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

getDataObjectDefinition

DataObjectDefinition getDataObjectDefinition(String dataObjectDefinitionId)

Returns the specified data object definition given by its id.

Parameters:

dataObjectDefinitionId - the id of the data objectdefinition

Returns:

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

getDataObjectDefinitionByKey

DataObjectDefinition getDataObjectDefinitionByKey(String dataObjectDefinitionKey)

getDataObjectDefinitionByKeyAndTenantId

DataObjectDefinition getDataObjectDefinitionByKeyAndTenantId(String dataObjectDefinitionKey,
                                                             String tenantId)

getDataObjectModel

DataObjectModel getDataObjectModel(String dataObjectDefinitionId)

getDataObjectModelByKey

DataObjectModel getDataObjectModelByKey(String dataObjectDefinitionKey)

getDataObjectModelByKeyAndTenantId

DataObjectModel getDataObjectModelByKeyAndTenantId(String dataObjectDefinitionKey,
                                                   String tenantId)

convertDataObjectModelToJson

String convertDataObjectModelToJson(String dataObjectDefinitionId)

createDataObjectSchemaDefinitionQuery

DataObjectSchemaDefinitionQuery createDataObjectSchemaDefinitionQuery()

performDataObjectSchemaDefinitionUpdate

void performDataObjectSchemaDefinitionUpdate(String dataObjectSchemaDefinitionId)

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

Parameters:

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

performDataObjectSchemaDefinitionRollback

void performDataObjectSchemaDefinitionRollback(String dataObjectSchemaDefinitionId)

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

Parameters:

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

getMasterDataModel

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.

Parameters:

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

Returns:

the master data model requested

deleteDeployment

void deleteDeployment(String deploymentId)

Deletes the given deployment.

Parameters:

deploymentId - id of the deployment, cannot be null.

createDeploymentQuery

DataObjectDeploymentQuery createDeploymentQuery()

Query deployments