Package org.camunda.bpm.engine
Interface RepositoryService
- All Known Implementing Classes:
RepositoryServiceImpl
public interface RepositoryService
Service providing access to the repository of process definitions and deployments.
- Author:
- Tom Baeyens, Falko Menge, Tijs Rademakers, Joram Barrez
-
Method Summary
Modifier and TypeMethodDescriptionvoid
activateProcessDefinitionById
(String processDefinitionId) Activates the process definition with the given id.void
activateProcessDefinitionById
(String processDefinitionId, boolean activateProcessInstances, Date activationDate) Activates the process definition with the given id.void
activateProcessDefinitionByKey
(String processDefinitionKey) Activates the process definition with the given key (=id in the bpmn20.xml file).void
activateProcessDefinitionByKey
(String processDefinitionKey, boolean activateProcessInstances, Date activationDate) Activates the process definition with the given key (=id in the bpmn20.xml file).void
addCandidateStarterGroup
(String processDefinitionId, String groupId) Deprecated.Use authorization mechanism instead.void
addCandidateStarterUser
(String processDefinitionId, String userId) Deprecated.Use authorization mechanism instead.Query case definitions.Query decision definitions.Query decision requirements definition.Starts creating a new deploymentcreateDeployment
(ProcessApplicationReference processApplication) Starts creating a newProcessApplicationDeployment
.Query process definitions.Query process definitions.void
deleteCandidateStarterGroup
(String processDefinitionId, String groupId) Deprecated.Use authorization mechanism instead.void
deleteCandidateStarterUser
(String processDefinitionId, String userId) Deprecated.Use authorization mechanism instead.void
deleteDeployment
(String deploymentId) Deletes the given deployment.void
deleteDeployment
(String deploymentId, boolean cascade) Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.void
deleteDeployment
(String deploymentId, boolean cascade, boolean skipCustomListeners) Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.void
deleteDeployment
(String deploymentId, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings) Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.void
deleteDeploymentCascade
(String deploymentId) Deprecated.void
deleteProcessDefinition
(String processDefinitionId) Deletes the process definition which belongs to the given process definition id.void
deleteProcessDefinition
(String processDefinitionId, boolean cascade) Deletes the process definition which belongs to the given process definition id.void
deleteProcessDefinition
(String processDefinitionId, boolean cascade, boolean skipCustomListeners) Deletes the process definition which belongs to the given process definition id.void
deleteProcessDefinition
(String processDefinitionId, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings) Deletes the process definition which belongs to the given process definition id.Fluent builder to delete process definitions.getBpmnModelInstance
(String processDefinitionId) Returns theBpmnModelInstance
for the given processDefinitionId.getCaseDefinition
(String caseDefinitionId) Returns theCaseDefinition
.getCaseDiagram
(String caseDefinitionId) Gives access to a deployed case diagram, e.g., a PNG image, through a stream of bytes.getCaseModel
(String caseDefinitionId) Gives access to a deployed case model, e.g., a CMMN 1.0 XML file, through a stream of bytes.getCmmnModelInstance
(String caseDefinitionId) Returns theCmmnModelInstance
for the given caseDefinitionId.getDecisionDefinition
(String decisionDefinitionId) Returns theDecisionDefinition
.getDecisionDiagram
(String decisionDefinitionId) Gives access to a deployed decision diagram, e.g., a PNG image, through a stream of bytes.getDecisionModel
(String decisionDefinitionId) Gives access to a deployed decision model, e.g., a DMN 1.1 XML file, through a stream of bytes.getDecisionRequirementsDefinition
(String decisionRequirementsDefinitionId) Returns theDecisionRequirementsDefinition
.getDecisionRequirementsDiagram
(String decisionRequirementsDefinitionId) Gives access to a deployed decision requirements diagram, e.g., a PNG image, through a stream of bytes.getDecisionRequirementsModel
(String decisionRequirementsDefinitionId) Gives access to a deployed decision requirements model, e.g., a DMN 1.1 XML file, through a stream of bytes.getDeploymentResourceNames
(String deploymentId) Retrieves a list of deployment resource names for the given deployment, ordered alphabetically.getDeploymentResources
(String deploymentId) Retrieves a list of deployment resources for the given deployment, ordered alphabetically by name.getDmnModelInstance
(String decisionDefinitionId) Returns theDmnModelInstance
for the given decisionDefinitionId.getIdentityLinksForProcessDefinition
(String processDefinitionId) Deprecated.Use authorization mechanism instead.getProcessDefinition
(String processDefinitionId) Returns theProcessDefinition
including all BPMN information like additional Properties (e.g.getProcessDiagram
(String processDefinitionId) Gives access to a deployed process diagram, e.g., a PNG image, through a stream of bytes.getProcessDiagramLayout
(String processDefinitionId) Provides positions and dimensions of elements in a process diagram as provided bygetProcessDiagram(String)
.getProcessModel
(String processDefinitionId) Gives access to a deployed process model, e.g., a BPMN 2.0 XML file, through a stream of bytes.getResourceAsStream
(String deploymentId, String resourceName) Gives access to a deployment resource through a stream of bytes.getResourceAsStreamById
(String deploymentId, String resourceId) Gives access to a deployment resource through a stream of bytes.getStaticCalledProcessDefinitions
(String processDefinitionId) For the given process, returns a list ofCalledProcessDefinition
.void
suspendProcessDefinitionById
(String processDefinitionId) Suspends the process definition with the given id.void
suspendProcessDefinitionById
(String processDefinitionId, boolean suspendProcessInstances, Date suspensionDate) Suspends the process definition with the given id.void
suspendProcessDefinitionByKey
(String processDefinitionKey) Suspends the all process definitions with the given key (= id in the bpmn20.xml file).void
suspendProcessDefinitionByKey
(String processDefinitionKey, boolean suspendProcessInstances, Date suspensionDate) Suspends the all process definitions with the given key (= id in the bpmn20.xml file).void
updateCaseDefinitionHistoryTimeToLive
(String caseDefinitionId, Integer historyTimeToLive) Updates time to live of case definition.void
updateDecisionDefinitionHistoryTimeToLive
(String decisionDefinitionId, Integer historyTimeToLive) Updates time to live of decision definition.void
updateProcessDefinitionHistoryTimeToLive
(String processDefinitionId, Integer historyTimeToLive) Updates time to live of process definition.Activate or suspend process definitions using a fluent builder.
-
Method Details
-
createDeployment
DeploymentBuilder createDeployment()Starts creating a new deployment -
createDeployment
ProcessApplicationDeploymentBuilder createDeployment(ProcessApplicationReference processApplication) Starts creating a newProcessApplicationDeployment
.- See Also:
-
deleteDeployment
Deletes the given deployment.- Parameters:
deploymentId
- id of the deployment, cannot be null.- Throws:
RuntimeException
- If there are still runtime or history process instances or jobs.AuthorizationException
- If the user has noPermissions.DELETE
permission onResources.DEPLOYMENT
.
-
deleteDeploymentCascade
Deprecated.usedeleteDeployment(String, boolean)
. This methods may be deleted from 5.3.Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.- Parameters:
deploymentId
- id of the deployment, cannot be null.- Throws:
AuthorizationException
- If the user has noPermissions.DELETE
permission onResources.DEPLOYMENT
.
-
deleteDeployment
Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.- Parameters:
deploymentId
- id of the deployment, cannot be null.- Throws:
AuthorizationException
- If the user has noPermissions.DELETE
permission onResources.DEPLOYMENT
.
-
deleteDeployment
Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.- Parameters:
deploymentId
- id of the deployment, cannot be null.cascade
- if set to true, all process instances (including) history are deletedskipCustomListeners
- if true, only the built-inExecutionListener
s are notified with theExecutionListener.EVENTNAME_END
event.- Throws:
AuthorizationException
- If the user has noPermissions.DELETE
permission onResources.DEPLOYMENT
.
-
deleteDeployment
void deleteDeployment(String deploymentId, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings) Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.- Parameters:
deploymentId
- id of the deployment, cannot be null.cascade
- if set to true, all process instances (including) history are deletedskipCustomListeners
- if true, only the built-inExecutionListener
s are notified with theExecutionListener.EVENTNAME_END
event.skipIoMappings
- specifies whether input/output mappings for tasks should be invoked- Throws:
AuthorizationException
- If the user has noPermissions.DELETE
permission onResources.DEPLOYMENT
.
-
deleteProcessDefinition
Deletes the process definition which belongs to the given process definition id. Same behavior asdeleteProcessDefinition(java.lang.String, boolean, boolean)
Both boolean parameters of this method are per default false. The deletion is in this case not cascading.- Parameters:
processDefinitionId
- the id, which corresponds to the process definition- Throws:
ProcessEngineException
- If the process definition does not existAuthorizationException
- If the user has noPermissions.DELETE
permission onResources.PROCESS_DEFINITION
.- See Also:
-
deleteProcessDefinition
Deletes the process definition which belongs to the given process definition id. Cascades the deletion if the cascade is set to true. Same behavior asdeleteProcessDefinition(java.lang.String, boolean, boolean)
The skipCustomListeners parameter is per default false. The custom listeners are called if the cascading flag is set to true and the process instances are deleted.- Parameters:
processDefinitionId
- the id, which corresponds to the process definitioncascade
- if set to true, all process instances (including) history are deleted- Throws:
ProcessEngineException
- If the process definition does not existAuthorizationException
- If the user has noPermissions.DELETE
permission onResources.PROCESS_DEFINITION
.- See Also:
-
deleteProcessDefinition
void deleteProcessDefinition(String processDefinitionId, boolean cascade, boolean skipCustomListeners) Deletes the process definition which belongs to the given process definition id. Cascades the deletion if the cascade is set to true the custom listener can be skipped if the third parameter is set to true.- Parameters:
processDefinitionId
- the id, which corresponds to the process definitioncascade
- if set to true, all process instances (including) history are deletedskipCustomListeners
- if true, only the built-inExecutionListener
s are notified with theExecutionListener.EVENTNAME_END
event. Is only used if cascade set to true.- Throws:
ProcessEngineException
- If the process definition does not existAuthorizationException
- If the user has noPermissions.DELETE
permission onResources.PROCESS_DEFINITION
.
-
deleteProcessDefinition
void deleteProcessDefinition(String processDefinitionId, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings) Deletes the process definition which belongs to the given process definition id. Cascades the deletion if the cascade is set to true, the custom listener can be skipped if the third parameter is set to true, io mappings can be skipped if the forth parameter is set to true.- Parameters:
processDefinitionId
- the id, which corresponds to the process definitioncascade
- if set to true, all process instances (including) history are deletedskipCustomListeners
- if true, only the built-inExecutionListener
s are notified with theExecutionListener.EVENTNAME_END
event. Is only used if cascade set to true.skipIoMappings
- Specifies whether input/output mappings for tasks should be invoked- Throws:
ProcessEngineException
- If the process definition does not existAuthorizationException
- If the user has noPermissions.DELETE
permission onResources.PROCESS_DEFINITION
.
-
deleteProcessDefinitions
DeleteProcessDefinitionsSelectBuilder deleteProcessDefinitions()Fluent builder to delete process definitions.- Returns:
- the builder to delete process definitions
-
getDeploymentResourceNames
Retrieves a list of deployment resource names for the given deployment, ordered alphabetically.- Parameters:
deploymentId
- id of the deployment, cannot be null.- Throws:
AuthorizationException
- If the user has noPermissions.READ
permission onResources.DEPLOYMENT
.
-
getDeploymentResources
Retrieves a list of deployment resources for the given deployment, ordered alphabetically by name.- Parameters:
deploymentId
- id of the deployment, cannot be null.- Throws:
AuthorizationException
- If the user has noPermissions.READ
permission onResources.DEPLOYMENT
.
-
getResourceAsStream
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:
ProcessEngineException
- When the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.AuthorizationException
- If the user has noPermissions.READ
permission onResources.DEPLOYMENT
.
-
getResourceAsStreamById
Gives access to a deployment resource through a stream of bytes.- Parameters:
deploymentId
- id of the deployment, cannot be null.resourceId
- id of the resource, cannot be null.- Throws:
ProcessEngineException
- When the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.AuthorizationException
- If the user has noPermissions.READ
permission onResources.DEPLOYMENT
.
-
createProcessDefinitionQuery
ProcessDefinitionQuery createProcessDefinitionQuery()Query process definitions. -
createCaseDefinitionQuery
CaseDefinitionQuery createCaseDefinitionQuery()Query case definitions. -
createDecisionDefinitionQuery
DecisionDefinitionQuery createDecisionDefinitionQuery()Query decision definitions. -
createDecisionRequirementsDefinitionQuery
DecisionRequirementsDefinitionQuery createDecisionRequirementsDefinitionQuery()Query decision requirements definition. -
createDeploymentQuery
DeploymentQuery createDeploymentQuery()Query process definitions. -
suspendProcessDefinitionById
Suspends the process definition with the given id. If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition. Note: all the process instances of the process definition will still be active (ie. not suspended)!Note: for more complex suspend commands use
updateProcessDefinitionSuspensionState()
.- Throws:
ProcessEngineException
- If no such processDefinition can be found.AuthorizationException
- If the user has none of the following:ProcessDefinitionPermissions.SUSPEND
permission onResources.PROCESS_DEFINITION
Permissions.UPDATE
permission onResources.PROCESS_DEFINITION
-
suspendProcessDefinitionById
void suspendProcessDefinitionById(String processDefinitionId, boolean suspendProcessInstances, Date suspensionDate) Suspends the process definition with the given id. If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition.Note: for more complex suspend commands use
updateProcessDefinitionSuspensionState()
.- Parameters:
suspendProcessInstances
- If true, all the process instances of the provided process definition will be suspended too.suspensionDate
- The date on which the process definition will be suspended. If null, the process definition is suspended immediately. Note: The job executor needs to be active to use this!- Throws:
ProcessEngineException
- If no such processDefinition can be found.AuthorizationException
-- If the user has no
Permissions.UPDATE
permission onResources.PROCESS_DEFINITION
.- and if
suspendProcessInstances
is set totrue
and the user has none of the following:ProcessInstancePermissions.SUSPEND
permission onResources.PROCESS_INSTANCE
ProcessDefinitionPermissions.SUSPEND_INSTANCE
permission onResources.PROCESS_DEFINITION
Permissions.UPDATE
permission onResources.PROCESS_INSTANCE
Permissions.UPDATE_INSTANCE
permission onResources.PROCESS_DEFINITION
- If the user has no
- See Also:
-
suspendProcessDefinitionByKey
Suspends the all process definitions with the given key (= id in the bpmn20.xml file). If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition. Note: all the process instances of the process definition will still be active (ie. not suspended)!Note: for more complex suspend commands use
updateProcessDefinitionSuspensionState()
.- Throws:
ProcessEngineException
- If no such processDefinition can be found.AuthorizationException
- If the user has none of the following:ProcessDefinitionPermissions.SUSPEND
permission onResources.PROCESS_DEFINITION
Permissions.UPDATE
permission onResources.PROCESS_DEFINITION
-
suspendProcessDefinitionByKey
void suspendProcessDefinitionByKey(String processDefinitionKey, boolean suspendProcessInstances, Date suspensionDate) Suspends the all process definitions with the given key (= id in the bpmn20.xml file). If a process definition is in state suspended, it will not be possible to start new process instances based on the process definition.Note: for more complex suspend commands use
updateProcessDefinitionSuspensionState()
.- Parameters:
suspendProcessInstances
- If true, all the process instances of the provided process definition will be suspended too.suspensionDate
- The date on which the process definition will be suspended. If null, the process definition is suspended immediately. Note: The job executor needs to be active to use this!- Throws:
ProcessEngineException
- If no such processDefinition can be found.AuthorizationException
-- If the user has no
Permissions.UPDATE
permission onResources.PROCESS_DEFINITION
.- and if
suspendProcessInstances
is set totrue
and the user has none of the following:ProcessInstancePermissions.SUSPEND
permission onResources.PROCESS_INSTANCE
ProcessDefinitionPermissions.SUSPEND_INSTANCE
permission onResources.PROCESS_DEFINITION
Permissions.UPDATE
permission onResources.PROCESS_INSTANCE
Permissions.UPDATE_INSTANCE
permission onResources.PROCESS_DEFINITION
- If the user has no
- See Also:
-
activateProcessDefinitionById
Activates the process definition with the given id.Note: for more complex activate commands use
updateProcessDefinitionSuspensionState()
.- Throws:
ProcessEngineException
- If no such processDefinition can be found or if the process definition is already in state active.AuthorizationException
- If the user has none of the following:ProcessDefinitionPermissions.SUSPEND
permission onResources.PROCESS_DEFINITION
Permissions.UPDATE
permission onResources.PROCESS_DEFINITION
-
activateProcessDefinitionById
void activateProcessDefinitionById(String processDefinitionId, boolean activateProcessInstances, Date activationDate) Activates the process definition with the given id.Note: for more complex activate commands use
updateProcessDefinitionSuspensionState()
.- Parameters:
suspendProcessInstances
- If true, all the process instances of the provided process definition will be activated too.activationDate
- The date on which the process definition will be activated. If null, the process definition is suspended immediately. Note: The job executor needs to be active to use this!- Throws:
ProcessEngineException
- If no such processDefinition can be found.AuthorizationException
-- If the user has no
Permissions.UPDATE
permission onResources.PROCESS_DEFINITION
.- and if
suspendProcessInstances
is set totrue
and the user has none of the following:ProcessInstancePermissions.SUSPEND
permission onResources.PROCESS_INSTANCE
ProcessDefinitionPermissions.SUSPEND_INSTANCE
permission onResources.PROCESS_DEFINITION
Permissions.UPDATE
permission onResources.PROCESS_INSTANCE
Permissions.UPDATE_INSTANCE
permission onResources.PROCESS_DEFINITION
- If the user has no
- See Also:
-
activateProcessDefinitionByKey
Activates the process definition with the given key (=id in the bpmn20.xml file).Note: for more complex activate commands use
updateProcessDefinitionSuspensionState()
.- Throws:
ProcessEngineException
- If no such processDefinition can be found.AuthorizationException
- If the user has none of the following:ProcessDefinitionPermissions.SUSPEND
permission onResources.PROCESS_DEFINITION
Permissions.UPDATE
permission onResources.PROCESS_DEFINITION
-
activateProcessDefinitionByKey
void activateProcessDefinitionByKey(String processDefinitionKey, boolean activateProcessInstances, Date activationDate) Activates the process definition with the given key (=id in the bpmn20.xml file).Note: for more complex activate commands use
updateProcessDefinitionSuspensionState()
.- Parameters:
suspendProcessInstances
- If true, all the process instances of the provided process definition will be activated too.activationDate
- The date on which the process definition will be activated. If null, the process definition is suspended immediately. Note: The job executor needs to be active to use this!- Throws:
ProcessEngineException
- If no such processDefinition can be found.AuthorizationException
-- If the user has no
Permissions.UPDATE
permission onResources.PROCESS_DEFINITION
.- and if
suspendProcessInstances
is set totrue
and the user has none of the following:ProcessInstancePermissions.SUSPEND
permission onResources.PROCESS_INSTANCE
ProcessDefinitionPermissions.SUSPEND_INSTANCE
permission onResources.PROCESS_DEFINITION
Permissions.UPDATE
permission onResources.PROCESS_INSTANCE
Permissions.UPDATE_INSTANCE
permission onResources.PROCESS_DEFINITION
- If the user has no
- See Also:
-
updateProcessDefinitionSuspensionState
UpdateProcessDefinitionSuspensionStateSelectBuilder updateProcessDefinitionSuspensionState()Activate or suspend process definitions using a fluent builder. Specify the definitions by calling one of the by methods, like byProcessDefinitionId. To update the suspension state callUpdateProcessDefinitionSuspensionStateBuilder.activate()
orUpdateProcessDefinitionSuspensionStateBuilder.suspend()
.- Returns:
- the builder to update the suspension state
-
updateProcessDefinitionHistoryTimeToLive
void updateProcessDefinitionHistoryTimeToLive(String processDefinitionId, Integer historyTimeToLive) Updates time to live of process definition. The field is used within history cleanup process.- Parameters:
processDefinitionId
- The id of the process definition to updatehistoryTimeToLive
- the value of history time to live to update- Throws:
AuthorizationException
- If the user has noPermissions.UPDATE
permission onResources.PROCESS_DEFINITION
.NotAllowedException
- in case feature flagenforceHistoryTimeToLive
is set totrue
and the given historyTimeToLive value isnull
.
-
updateDecisionDefinitionHistoryTimeToLive
void updateDecisionDefinitionHistoryTimeToLive(String decisionDefinitionId, Integer historyTimeToLive) Updates time to live of decision definition. The field is used within history cleanup process.- Parameters:
decisionDefinitionId
- The id of the decision definition to updatehistoryTimeToLive
- the value of history time to live to update- Throws:
AuthorizationException
- If the user has noPermissions.UPDATE
permission onResources.DECISION_DEFINITION
.NotAllowedException
- in case feature flagenforceHistoryTimeToLive
is set totrue
and the given historyTimeToLive value isnull
.
-
updateCaseDefinitionHistoryTimeToLive
Updates time to live of case definition. The field is used within history cleanup process.- Parameters:
caseDefinitionId
- The given case definition id to updatehistoryTimeToLive
- the value of history time to live to update- Throws:
NotAllowedException
- in case feature flagenforceHistoryTimeToLive
is set to true and the given historyTimeToLive value isnull
.
-
getProcessModel
Gives access to a deployed process model, e.g., a BPMN 2.0 XML file, through a stream of bytes.- Parameters:
processDefinitionId
- id of aProcessDefinition
, cannot be null.- Throws:
NotFoundException
- when the process model doesn't exist.AuthorizationException
- If the user has noPermissions.READ
permission onResources.PROCESS_DEFINITION
.
-
getProcessDiagram
Gives access to a deployed process diagram, e.g., a PNG image, through a stream of bytes.- Parameters:
processDefinitionId
- id of aProcessDefinition
, cannot be null.- Returns:
- null when the diagram resource name of a
ProcessDefinition
is null. - Throws:
ProcessEngineException
- when the process diagram doesn't exist.AuthorizationException
- If the user has noPermissions.READ
permission onResources.PROCESS_DEFINITION
.
-
getProcessDefinition
Returns theProcessDefinition
including all BPMN information like additional Properties (e.g. documentation).- Throws:
AuthorizationException
- If the user has noPermissions.READ
permission onResources.PROCESS_DEFINITION
.
-
getProcessDiagramLayout
Provides positions and dimensions of elements in a process diagram as provided bygetProcessDiagram(String)
. This method requires a process model and a diagram image to be deployed.- Parameters:
processDefinitionId
- id of aProcessDefinition
, cannot be null.- Returns:
- Map with process element ids as keys and positions and dimensions as values.
- Throws:
ProcessEngineException
- When the process model or diagram doesn't exist.AuthorizationException
- If the user has noPermissions.READ
permission onResources.PROCESS_DEFINITION
.
-
getBpmnModelInstance
Returns theBpmnModelInstance
for the given processDefinitionId.- Parameters:
processDefinitionId
- the id of the Process Definition for which theBpmnModelInstance
should be retrieved.- Returns:
- the
BpmnModelInstance
- Throws:
AuthorizationException
- If the user has noPermissions.READ
permission onResources.PROCESS_DEFINITION
.
-
getCmmnModelInstance
Returns theCmmnModelInstance
for the given caseDefinitionId.- Parameters:
caseDefinitionId
- the id of the Case Definition for which theCmmnModelInstance
should be retrieved.- Returns:
- the
CmmnModelInstance
- Throws:
NotValidException
- when the given case definition id or deployment id or resource name is nullNotFoundException
- when no CMMN model instance or deployment resource is found for the given case definition idProcessEngineException
- when an internal exception happens during the execution of the command.
-
getDmnModelInstance
Returns theDmnModelInstance
for the given decisionDefinitionId.- Parameters:
decisionDefinitionId
- the id of the Decision Definition for which theDmnModelInstance
should be retrieved.- Returns:
- the
DmnModelInstance
- Throws:
NotValidException
- when the given decision definition id or deployment id or resource name is nullNotFoundException
- when no DMN model instance or deployment resource is found for the given decision definition idProcessEngineException
- when an internal exception happens during the execution of the command.AuthorizationException
- If the user has noPermissions.READ
permission onResources.DECISION_DEFINITION
.
-
addCandidateStarterUser
Deprecated.Use authorization mechanism instead.Authorizes a candidate user for a process definition.- Parameters:
processDefinitionId
- id of the process definition, cannot be null.userId
- id of the user involve, cannot be null.- Throws:
ProcessEngineException
- When the process definition or user doesn't exist.
-
addCandidateStarterGroup
Deprecated.Use authorization mechanism instead.Authorizes a candidate group for a process definition.- Parameters:
processDefinitionId
- id of the process definition, cannot be null.groupId
- id of the group involve, cannot be null.- Throws:
ProcessEngineException
- When the process definition or group doesn't exist.
-
deleteCandidateStarterUser
Deprecated.Use authorization mechanism instead.Removes the authorization of a candidate user for a process definition.- Parameters:
processDefinitionId
- id of the process definition, cannot be null.userId
- id of the user involve, cannot be null.- Throws:
ProcessEngineException
- When the process definition or user doesn't exist.
-
deleteCandidateStarterGroup
Deprecated.Use authorization mechanism instead.Removes the authorization of a candidate group for a process definition.- Parameters:
processDefinitionId
- id of the process definition, cannot be null.groupId
- id of the group involve, cannot be null.- Throws:
ProcessEngineException
- When the process definition or group doesn't exist.
-
getIdentityLinksForProcessDefinition
Deprecated.Use authorization mechanism instead.Retrieves theIdentityLink
s associated with the given process definition. Such anIdentityLink
informs how a certain identity (eg. group or user) is authorized for a certain process definition -
getCaseDefinition
Returns theCaseDefinition
.- Throws:
NotValidException
- when the given case definition id is nullNotFoundException
- when no case definition is found for the given case definition idProcessEngineException
- when an internal exception happens during the execution of the command.
-
getCaseModel
Gives access to a deployed case model, e.g., a CMMN 1.0 XML file, through a stream of bytes.- Parameters:
caseDefinitionId
- id of aCaseDefinition
, cannot be null.- Throws:
NotValidException
- when the given case definition id or deployment id or resource name is nullNotFoundException
- when no case definition or deployment resource is found for the given case definition idProcessEngineException
- when an internal exception happens during the execution of the command
-
getCaseDiagram
Gives access to a deployed case diagram, e.g., a PNG image, through a stream of bytes.- Parameters:
caseDefinitionId
- id of aCaseDefinition
, cannot be null.- Returns:
- null when the diagram resource name of a
CaseDefinition
is null. - Throws:
ProcessEngineException
- when the process diagram doesn't exist.
-
getDecisionDefinition
Returns theDecisionDefinition
.- Throws:
NotValidException
- when the given decision definition id is nullNotFoundException
- when no decision definition is found for the given decision definition idProcessEngineException
- when an internal exception happens during the execution of the command.AuthorizationException
- If the user has noPermissions.READ
permission onResources.DECISION_DEFINITION
.
-
getDecisionRequirementsDefinition
DecisionRequirementsDefinition getDecisionRequirementsDefinition(String decisionRequirementsDefinitionId) Returns theDecisionRequirementsDefinition
.- Throws:
NotValidException
- when the given decision requirements definition id is nullNotFoundException
- when no decision requirements definition is found for the given decision requirements definition idProcessEngineException
- when an internal exception happens during the execution of the command.AuthorizationException
- If the user has noPermissions.READ
permission onResources.DECISION_REQUIREMENTS_DEFINITION
.
-
getDecisionModel
Gives access to a deployed decision model, e.g., a DMN 1.1 XML file, through a stream of bytes.- Parameters:
decisionDefinitionId
- id of aDecisionDefinition
, cannot be null.- Throws:
NotValidException
- when the given decision definition id or deployment id or resource name is nullNotFoundException
- when no decision definition or deployment resource is found for the given decision definition idProcessEngineException
- when an internal exception happens during the execution of the commandAuthorizationException
- If the user has noPermissions.READ
permission onResources.DECISION_DEFINITION
.
-
getDecisionRequirementsModel
Gives access to a deployed decision requirements model, e.g., a DMN 1.1 XML file, through a stream of bytes.- Parameters:
decisionRequirementsDefinitionId
- id of aDecisionRequirementsDefinition
, cannot be null.- Throws:
NotValidException
- when the given decision requirements definition id or deployment id or resource name is nullNotFoundException
- when no decision requirements definition or deployment resource is found for the given decision requirements definition idProcessEngineException
- when an internal exception happens during the execution of the commandAuthorizationException
- If the user has noPermissions.READ
permission onResources.DECISION_REQUIREMENTS_DEFINITION
.
-
getDecisionDiagram
Gives access to a deployed decision diagram, e.g., a PNG image, through a stream of bytes.- Parameters:
decisionDefinitionId
- id of aDecisionDefinition
, cannot be null.- Returns:
- null when the diagram resource name of a
DecisionDefinition
is null. - Throws:
ProcessEngineException
- when the decision diagram doesn't exist.AuthorizationException
- If the user has noPermissions.READ
permission onResources.DECISION_DEFINITION
.
-
getDecisionRequirementsDiagram
Gives access to a deployed decision requirements diagram, e.g., a PNG image, through a stream of bytes.- Parameters:
decisionRequirementsDefinitionId
- id of aDecisionRequirementsDefinition
, cannot be null.- Returns:
- null when the diagram resource name of a
DecisionRequirementsDefinition
is null. - Throws:
ProcessEngineException
- when the decision requirements diagram doesn't exist.AuthorizationException
- If the user has noPermissions.READ
permission onResources.DECISION_REQUIREMENTS_DEFINITION
.
-
getStaticCalledProcessDefinitions
For the given process, returns a list ofCalledProcessDefinition
. The list contains all processes that are referenced statically by call activities in the given process. This method does not resolve process definitions that are referenced with expressions. EachCalledProcessDefinition
contains a list of call activity ids, which specifies the call activities that are calling that process. This method does not resolve references to case definitions.- Parameters:
processDefinitionId
- id of aProcessDefinition
- Returns:
- a list of
CalledProcessDefinition
. - Throws:
NotFoundException
- When the process definition doesn't exist.AuthorizationException
- If the user has noPermissions.READ
permission onResources.PROCESS_DEFINITION
.
-