Package com.flowable.platform.api.repository

Interface PlatformRepositoryService

All Known Implementing Classes:

PlatformRepositoryServiceImpl

public interface PlatformRepositoryService

Method Summary

Modifier and Type	Method	Description
String	convertDataDictionaryModelToJson(String definitionId)	Returns the DataDictionaryModel as a JSON string.
String	convertQueryDefinitionModelToJson(String queryDefinitionId)	Returns the QueryDefinitionModel as a JSON string.
String	convertSequenceDefinitionModelToJson(String definitionId)	Returns the SequenceDefinitionModel as a JSON string.
String	convertVariableExtractorDefinitionModelToJson(String variableExtractorDefinitionId)	Returns the VariableExtractorDefinitionModel as a JSON string.
DataDictionaryDefinitionQuery	createDataDictionaryDefinitionQuery()	Data dictionary definitions
PlatformDeploymentBuilder	createDeployment()	Starts creating a new deployment
PlatformDeploymentQuery	createDeploymentQuery()	Platform deployments
QueryDefinitionQuery	createQueryDefinitionQuery()	Query definitions
SequenceDefinitionQuery	createSequenceDefinitionQuery()	Sequence definitions
VariableExtractorDefinitionQuery	createVariableExtractorDefinitionQuery()	Variable extractor definitions
WorkDefinitionQuery	createWorkDefinitionQuery()	Query work definitions, e.g.
void	deleteDeployment(String deploymentId)	Deletes the given deployment.
DataDictionaryDefinition	getDataDictionaryDefinition(String definitionId)	Returns the DataDictionaryDefinition
DataDictionaryDefinition	getDataDictionaryDefinitionByKey(String definitionKey)	Returns the DataDictionaryDefinition.
DataDictionaryDefinition	getDataDictionaryDefinitionByKeyAndTenantId(String definitionKey, String tenantId)	Returns the DataDictionaryDefinition.
DataDictionaryModel	getDataDictionaryModel(String definitionId)	Returns the DataDictionaryModel.
DataDictionaryModel	getDataDictionaryModelByKey(String definitionKey)	Returns the DataDictionaryModel using the definition key and resolving the key to the latest version.
DataDictionaryModel	getDataDictionaryModelByKeyAndTenantId(String definitionKey, String tenantId)	Returns the DataDictionaryModel using the definition key and resolving the key to the latest version within the given tenant.
List<String>	getDeploymentResourceNames(String deploymentId)	Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
QueryDefinition	getQueryDefinition(String queryDefinitionId)	Returns the QueryDefinition
QueryDefinition	getQueryDefinitionByKey(String queryDefinitionKey)	Returns the QueryDefinition The latest version for the given key will be returned.
QueryDefinition	getQueryDefinitionByKeyAndTenantId(String queryDefinitionKey, String tenantId)	Returns the QueryDefinition.
QueryDefinitionModel	getQueryDefinitionModel(String queryDefinitionId)	Returns the QueryDefinitionModel including all query model info.
QueryDefinitionModel	getQueryDefinitionModelByKey(String QueryDefinitionKey)	Returns the QueryDefinitionModel including all query model info, using the query definition key and resolving the key to the latest version.
QueryDefinitionModel	getQueryDefinitionModelByKeyAndTenantId(String QueryDefinitionKey, String tenantId)	Returns the QueryDefinitionModel including all query model info, using the query definition key and resolving the key to the latest version.
InputStream	getResourceAsStream(String deploymentId, String resourceName)	Gives access to a deployment resource through a stream of bytes.
SequenceDefinition	getSequenceDefinition(String definitionId)	Returns the SequenceDefinition
SequenceDefinition	getSequenceDefinitionByKey(String definitionKey)	Returns the SequenceDefinition.
SequenceDefinition	getSequenceDefinitionByKeyAndTenantId(String definitionKey, String tenantId)	Returns the SequenceDefinition.
SequenceDefinitionModel	getSequenceDefinitionModel(String definitionId)	Returns the SequenceDefinitionModel including all sequence model info.
SequenceDefinitionModel	getSequenceDefinitionModelByKey(String definitionKey)	Returns the SequenceDefinitionModel including all sequence model info, using the sequence definition key and resolving the key to the latest version.
SequenceDefinitionModel	getSequenceDefinitionModelByKeyAndTenantId(String definitionKey, String tenantId)	Returns the SequenceDefinitionModel including all sequence model info, using the sequence definition key and resolving the key to the latest version.
VariableExtractorDefinition	getVariableExtractorDefinition(String variableExtractorDefinitionId)	Returns the VariableExtractorDefinition
VariableExtractorDefinition	getVariableExtractorDefinitionByKey(String variableExtractorDefinitionKey)	Returns the VariableExtractorDefinition The latest version for the given key will be returned.
VariableExtractorDefinition	getVariableExtractorDefinitionByKeyAndTenantId(String variableExtractorDefinitionKey, String tenantId)	Returns the VariableExtractorDefinition.
VariableExtractorDefinitionModel	getVariableExtractorDefinitionModel(String variableExtractorDefinitionId)	Returns the VariableExtractorDefinitionModel including all variable extractor model info.
VariableExtractorDefinitionModel	getVariableExtractorDefinitionModelByKey(String VariableExtractorDefinitionKey)	Returns the VariableExtractorDefinitionModel including all variable extractor model info, using the variable extractor definition key and resolving the key to the latest version.
VariableExtractorDefinitionModel	getVariableExtractorDefinitionModelByKeyAndTenantId(String VariableExtractorDefinitionKey, String tenantId)	Returns the VariableExtractorDefinitionModel including all variable extractor model info, using the variable extractor definition key and resolving the key to the latest version.

Method Detail

createDeployment

PlatformDeploymentBuilder 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.

getQueryDefinitionModel

QueryDefinitionModel getQueryDefinitionModel(String queryDefinitionId)

Returns the QueryDefinitionModel including all query model info.

getVariableExtractorDefinitionModel

VariableExtractorDefinitionModel getVariableExtractorDefinitionModel(String variableExtractorDefinitionId)

Returns the VariableExtractorDefinitionModel including all variable extractor model info.

getQueryDefinitionModelByKey

QueryDefinitionModel getQueryDefinitionModelByKey(String QueryDefinitionKey)

Returns the QueryDefinitionModel including all query model info, using the query definition key and resolving the key to the latest version.

getVariableExtractorDefinitionModelByKey

VariableExtractorDefinitionModel getVariableExtractorDefinitionModelByKey(String VariableExtractorDefinitionKey)

Returns the VariableExtractorDefinitionModel including all variable extractor model info, using the variable extractor definition key and resolving the key to the latest version.

getQueryDefinitionModelByKeyAndTenantId

QueryDefinitionModel getQueryDefinitionModelByKeyAndTenantId(String QueryDefinitionKey,
                                                             String tenantId)

Returns the QueryDefinitionModel including all query model info, using the query definition key and resolving the key to the latest version.

getVariableExtractorDefinitionModelByKeyAndTenantId

VariableExtractorDefinitionModel getVariableExtractorDefinitionModelByKeyAndTenantId(String VariableExtractorDefinitionKey,
                                                                                     String tenantId)

Returns the VariableExtractorDefinitionModel including all variable extractor model info, using the variable extractor definition key and resolving the key to the latest version.

convertQueryDefinitionModelToJson

String convertQueryDefinitionModelToJson(String queryDefinitionId)

Returns the QueryDefinitionModel as a JSON string.

convertVariableExtractorDefinitionModelToJson

String convertVariableExtractorDefinitionModelToJson(String variableExtractorDefinitionId)

Returns the VariableExtractorDefinitionModel as a JSON string.

getQueryDefinition

QueryDefinition getQueryDefinition(String queryDefinitionId)

Returns the QueryDefinition

getVariableExtractorDefinition

VariableExtractorDefinition getVariableExtractorDefinition(String variableExtractorDefinitionId)

Returns the VariableExtractorDefinition

getQueryDefinitionByKey

QueryDefinition getQueryDefinitionByKey(String queryDefinitionKey)

Returns the QueryDefinition The latest version for the given key will be returned.

getVariableExtractorDefinitionByKey

VariableExtractorDefinition getVariableExtractorDefinitionByKey(String variableExtractorDefinitionKey)

Returns the VariableExtractorDefinition The latest version for the given key will be returned.

getQueryDefinitionByKeyAndTenantId

QueryDefinition getQueryDefinitionByKeyAndTenantId(String queryDefinitionKey,
                                                   String tenantId)

Returns the QueryDefinition. The latest version for the given key will be returned.

getVariableExtractorDefinitionByKeyAndTenantId

VariableExtractorDefinition getVariableExtractorDefinitionByKeyAndTenantId(String variableExtractorDefinitionKey,
                                                                           String tenantId)

Returns the VariableExtractorDefinition. The latest version for the given key will be returned.

getSequenceDefinitionModel

SequenceDefinitionModel getSequenceDefinitionModel(String definitionId)

Returns the SequenceDefinitionModel including all sequence model info.

getSequenceDefinitionModelByKey

SequenceDefinitionModel getSequenceDefinitionModelByKey(String definitionKey)

Returns the SequenceDefinitionModel including all sequence model info, using the sequence definition key and resolving the key to the latest version.

getSequenceDefinitionModelByKeyAndTenantId

SequenceDefinitionModel getSequenceDefinitionModelByKeyAndTenantId(String definitionKey,
                                                                   String tenantId)

Returns the SequenceDefinitionModel including all sequence model info, using the sequence definition key and resolving the key to the latest version.

convertSequenceDefinitionModelToJson

String convertSequenceDefinitionModelToJson(String definitionId)

Returns the SequenceDefinitionModel as a JSON string.

getSequenceDefinition

SequenceDefinition getSequenceDefinition(String definitionId)

Returns the SequenceDefinition

getSequenceDefinitionByKey

SequenceDefinition getSequenceDefinitionByKey(String definitionKey)

Returns the SequenceDefinition. The latest version for the given key will be returned.

getSequenceDefinitionByKeyAndTenantId

SequenceDefinition getSequenceDefinitionByKeyAndTenantId(String definitionKey,
                                                         String tenantId)

Returns the SequenceDefinition. The latest version for the given key will be returned.

getDataDictionaryModel

DataDictionaryModel getDataDictionaryModel(String definitionId)

Returns the DataDictionaryModel.

getDataDictionaryModelByKey

DataDictionaryModel getDataDictionaryModelByKey(String definitionKey)

Returns the DataDictionaryModel using the definition key and resolving the key to the latest version.

getDataDictionaryModelByKeyAndTenantId

DataDictionaryModel getDataDictionaryModelByKeyAndTenantId(String definitionKey,
                                                           String tenantId)

Returns the DataDictionaryModel using the definition key and resolving the key to the latest version within the given tenant.

convertDataDictionaryModelToJson

String convertDataDictionaryModelToJson(String definitionId)

Returns the DataDictionaryModel as a JSON string.

getDataDictionaryDefinition

DataDictionaryDefinition getDataDictionaryDefinition(String definitionId)

Returns the DataDictionaryDefinition

getDataDictionaryDefinitionByKey

DataDictionaryDefinition getDataDictionaryDefinitionByKey(String definitionKey)

Returns the DataDictionaryDefinition. The latest version for the given key will be returned.

getDataDictionaryDefinitionByKeyAndTenantId

DataDictionaryDefinition getDataDictionaryDefinitionByKeyAndTenantId(String definitionKey,
                                                                     String tenantId)

Returns the DataDictionaryDefinition. The latest version for the given key and tenant will be returned.

deleteDeployment

void deleteDeployment(String deploymentId)

Deletes the given deployment.

Parameters:

deploymentId - id of the deployment, cannot be null.

createDeploymentQuery

PlatformDeploymentQuery createDeploymentQuery()

Platform deployments

createQueryDefinitionQuery

QueryDefinitionQuery createQueryDefinitionQuery()

Query definitions

createVariableExtractorDefinitionQuery

VariableExtractorDefinitionQuery createVariableExtractorDefinitionQuery()

Variable extractor definitions

createSequenceDefinitionQuery

SequenceDefinitionQuery createSequenceDefinitionQuery()

Sequence definitions

createDataDictionaryDefinitionQuery

DataDictionaryDefinitionQuery createDataDictionaryDefinitionQuery()

Data dictionary definitions

createWorkDefinitionQuery

WorkDefinitionQuery createWorkDefinitionQuery()

Query work definitions, e.g. processes / cases