org.flowable.cmmn.api

Interface CmmnRepositoryService

public interface CmmnRepositoryService

Method Summary

Modifier and Type	Method and Description
CaseDefinitionQuery	createCaseDefinitionQuery() Query case definitions
CmmnDeploymentBuilder	createDeployment() Starts creating a new deployment
CmmnDeploymentQuery	createDeploymentQuery() Query deployments
void	deleteDeployment(String deploymentId, boolean cascade) Deletes the given deployment and cascade deletion to case instances, history case instances and jobs.
CaseDefinition	getCaseDefinition(String caseDefinitionId) Returns the CaseDefinition including all CMMN information like additional Properties (e.g.
InputStream	getCaseDiagram(String caseDefinitionId) Gives access to a deployed case diagram, e.g., a PNG image, through a stream of bytes.
CmmnModel	getCmmnModel(String caseDefinitionId) Gives access to a deployed case model, e.g., a CMMN 1.1 XML file, through a stream of bytes.
List<DmnDecisionTable>	getDecisionTablesForCaseDefinition(String caseDefinitionId) Retrieves the DmnDecisionTables associated with the given case definition.
List<String>	getDeploymentResourceNames(String deploymentId) Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
List<FormDefinition>	getFormDefinitionsForCaseDefinition(String caseDefinitionId) Retrieves the FormDefinitions associated with the given case definition.
InputStream	getResourceAsStream(String deploymentId, String resourceName) Gives access to a deployment resource through a stream of bytes.
void	setCaseDefinitionCategory(String caseDefinitionId, String category) Sets the category of the case definition.

Method Detail

createDeployment

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

getCaseDefinition

CaseDefinition getCaseDefinition(String caseDefinitionId)

Returns the CaseDefinition including all CMMN information like additional Properties (e.g. documentation).

getCmmnModel

CmmnModel getCmmnModel(String caseDefinitionId)

Gives access to a deployed case model, e.g., a CMMN 1.1 XML file, through a stream of bytes.

Parameters:

caseDefinitionId - id of a CaseDefinition, cannot be null.

Throws:

FlowableObjectNotFoundException - when the case model doesn't exist.

getCaseDiagram

InputStream getCaseDiagram(String caseDefinitionId)

Gives access to a deployed case diagram, e.g., a PNG image, through a stream of bytes.

Parameters:

caseDefinitionId - id of a CaseDefinition, cannot be null.

Returns:

null when the diagram resource name of a CaseDefinition is null.

Throws:

FlowableObjectNotFoundException - when the case diagram doesn't exist.

deleteDeployment

void deleteDeployment(String deploymentId,
                      boolean cascade)

Deletes the given deployment and cascade deletion to case instances, history case instances and jobs.

Parameters:

deploymentId - id of the deployment, cannot be null.

createDeploymentQuery

CmmnDeploymentQuery createDeploymentQuery()

Query deployments

createCaseDefinitionQuery

CaseDefinitionQuery createCaseDefinitionQuery()

Query case definitions

setCaseDefinitionCategory

void setCaseDefinitionCategory(String caseDefinitionId,
                               String category)

Sets the category of the case definition. Case definitions can be queried by category: see CaseDefinitionQuery.caseDefinitionCategory(String).

Throws:

FlowableObjectNotFoundException - if no case definition with the provided id can be found.

getDecisionTablesForCaseDefinition

List<DmnDecisionTable> getDecisionTablesForCaseDefinition(String caseDefinitionId)

Retrieves the DmnDecisionTables associated with the given case definition.

Parameters:

caseDefinitionId - id of the case definition, cannot be null.

getFormDefinitionsForCaseDefinition

List<FormDefinition> getFormDefinitionsForCaseDefinition(String caseDefinitionId)

Retrieves the FormDefinitions associated with the given case definition.

Parameters:

caseDefinitionId - id of the case definition, cannot be null.