org.camunda.bpm.engine.RepositoryService Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.camunda.bpm.engine;
import java.io.InputStream;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import org.camunda.bpm.application.ProcessApplicationReference;
import org.camunda.bpm.engine.authorization.Permissions;
import org.camunda.bpm.engine.authorization.ProcessDefinitionPermissions;
import org.camunda.bpm.engine.authorization.ProcessInstancePermissions;
import org.camunda.bpm.engine.authorization.Resources;
import org.camunda.bpm.engine.delegate.ExecutionListener;
import org.camunda.bpm.engine.exception.NotAllowedException;
import org.camunda.bpm.engine.exception.NotFoundException;
import org.camunda.bpm.engine.exception.NotValidException;
import org.camunda.bpm.engine.repository.CaseDefinition;
import org.camunda.bpm.engine.repository.CaseDefinitionQuery;
import org.camunda.bpm.engine.repository.DecisionDefinition;
import org.camunda.bpm.engine.repository.DecisionDefinitionQuery;
import org.camunda.bpm.engine.repository.DecisionRequirementsDefinition;
import org.camunda.bpm.engine.repository.DecisionRequirementsDefinitionQuery;
import org.camunda.bpm.engine.repository.DeleteProcessDefinitionsSelectBuilder;
import org.camunda.bpm.engine.repository.DeploymentBuilder;
import org.camunda.bpm.engine.repository.DeploymentQuery;
import org.camunda.bpm.engine.repository.DiagramLayout;
import org.camunda.bpm.engine.repository.ProcessApplicationDeployment;
import org.camunda.bpm.engine.repository.ProcessApplicationDeploymentBuilder;
import org.camunda.bpm.engine.repository.ProcessDefinition;
import org.camunda.bpm.engine.repository.ProcessDefinitionQuery;
import org.camunda.bpm.engine.repository.Resource;
import org.camunda.bpm.engine.repository.CalledProcessDefinition;
import org.camunda.bpm.engine.repository.UpdateProcessDefinitionSuspensionStateBuilder;
import org.camunda.bpm.engine.repository.UpdateProcessDefinitionSuspensionStateSelectBuilder;
import org.camunda.bpm.engine.task.IdentityLink;
import org.camunda.bpm.model.bpmn.BpmnModelInstance;
import org.camunda.bpm.model.cmmn.CmmnModelInstance;
import org.camunda.bpm.model.dmn.DmnModelInstance;
/** Service providing access to the repository of process definitions and deployments.
*
* @author Tom Baeyens
* @author Falko Menge
* @author Tijs Rademakers
* @author Joram Barrez
*/
public interface RepositoryService {
/**
* Starts creating a new deployment
*/
DeploymentBuilder createDeployment();
/**
* Starts creating a new {@link ProcessApplicationDeployment}.
*
* @see ProcessApplicationDeploymentBuilder
*/
ProcessApplicationDeploymentBuilder createDeployment(ProcessApplicationReference processApplication);
/**
* Deletes the given deployment.
*
* @param deploymentId id of the deployment, cannot be null.
*
* @throws RuntimeException
* If there are still runtime or history process instances or jobs.
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#DEPLOYMENT}.
*/
void deleteDeployment(String deploymentId);
/**
* Deletes the given deployment and cascade deletion to process instances,
* history process instances and jobs.
*
* @param deploymentId id of the deployment, cannot be null.
*
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#DEPLOYMENT}.
*
* @deprecated use {@link #deleteDeployment(String, boolean)}. This methods may be deleted from 5.3.
*/
@Deprecated
void deleteDeploymentCascade(String deploymentId);
/**
* Deletes the given deployment and cascade deletion to process instances,
* history process instances and jobs.
*
* @param deploymentId id of the deployment, cannot be null.
*
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#DEPLOYMENT}.
*/
void deleteDeployment(String deploymentId, boolean cascade);
/**
* Deletes the given deployment and cascade deletion to process instances,
* history process instances and jobs.
*
* @param deploymentId id of the deployment, cannot be null.
* @param cascade if set to true, all process instances (including) history are deleted
* @param skipCustomListeners if true, only the built-in {@link ExecutionListener}s
* are notified with the {@link ExecutionListener#EVENTNAME_END} event.
*
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#DEPLOYMENT}.
*/
void deleteDeployment(String deploymentId, boolean cascade, boolean skipCustomListeners);
/**
* Deletes the given deployment and cascade deletion to process instances,
* history process instances and jobs.
*
* @param deploymentId id of the deployment, cannot be null.
* @param cascade if set to true, all process instances (including) history are deleted
* @param skipCustomListeners if true, only the built-in {@link ExecutionListener}s
* are notified with the {@link ExecutionListener#EVENTNAME_END} event.
* @param skipIoMappings specifies whether input/output mappings for tasks should be invoked
*
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#DEPLOYMENT}.
*/
void deleteDeployment(String deploymentId, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings);
/**
* Deletes the process definition which belongs to the given process definition id.
* Same behavior as {@link RepositoryService#deleteProcessDefinition(java.lang.String, boolean, boolean)}
* Both boolean parameters of this method are per default false. The deletion is
* in this case not cascading.
*
* @param processDefinitionId the id, which corresponds to the process definition
* @throws ProcessEngineException
* If the process definition does not exist
*
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#PROCESS_DEFINITION}.
* @see RepositoryService#deleteProcessDefinition(java.lang.String, boolean, boolean)
*/
void deleteProcessDefinition(String processDefinitionId);
/**
* Deletes the process definition which belongs to the given process definition id.
* Cascades the deletion if the cascade is set to true.
* Same behavior as {@link RepositoryService#deleteProcessDefinition(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.
*
* @param processDefinitionId the id, which corresponds to the process definition
* @param cascade if set to true, all process instances (including) history are deleted
* @throws ProcessEngineException
* If the process definition does not exist
*
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#PROCESS_DEFINITION}.
* @see RepositoryService#deleteProcessDefinition(java.lang.String, boolean, boolean)
*/
void deleteProcessDefinition(String processDefinitionId, boolean cascade);
/**
* 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.
*
* @param processDefinitionId the id, which corresponds to the process definition
* @param cascade if set to true, all process instances (including) history are deleted
* @param skipCustomListeners if true, only the built-in {@link ExecutionListener}s
* are notified with the {@link ExecutionListener#EVENTNAME_END} event.
* Is only used if cascade set to true.
*
* @throws ProcessEngineException
* If the process definition does not exist
*
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#PROCESS_DEFINITION}.
*/
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, io mappings can be skipped if the forth parameter is set to true.
*
* @param processDefinitionId the id, which corresponds to the process definition
* @param cascade if set to true, all process instances (including) history are deleted
* @param skipCustomListeners if true, only the built-in {@link ExecutionListener}s
* are notified with the {@link ExecutionListener#EVENTNAME_END} event.
* Is only used if cascade set to true.
* @param skipIoMappings Specifies whether input/output mappings for tasks should be invoked
*
* @throws ProcessEngineException
* If the process definition does not exist
*
* @throws AuthorizationException
* If the user has no {@link Permissions#DELETE} permission on {@link Resources#PROCESS_DEFINITION}.
*/
void deleteProcessDefinition(String processDefinitionId, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings);
/**
* Fluent builder to delete process definitions.
*
* @return the builder to delete process definitions
*/
DeleteProcessDefinitionsSelectBuilder deleteProcessDefinitions();
/**
* Retrieves a list of deployment resource names for the given deployment,
* ordered alphabetically.
*
* @param deploymentId id of the deployment, cannot be null.
*
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DEPLOYMENT}.
*/
List getDeploymentResourceNames(String deploymentId);
/**
* Retrieves a list of deployment resources for the given deployment,
* ordered alphabetically by name.
*
* @param deploymentId id of the deployment, cannot be null.
*
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DEPLOYMENT}.
*/
List getDeploymentResources(String deploymentId);
/**
* Gives access to a deployment resource through a stream of bytes.
*
* @param deploymentId id of the deployment, cannot be null.
* @param 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.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DEPLOYMENT}.
*/
InputStream getResourceAsStream(String deploymentId, String resourceName);
/**
* Gives access to a deployment resource through a stream of bytes.
*
* @param deploymentId id of the deployment, cannot be null.
* @param 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.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DEPLOYMENT}.
*/
InputStream getResourceAsStreamById(String deploymentId, String resourceId);
/**
* Query process definitions.
*/
ProcessDefinitionQuery createProcessDefinitionQuery();
/**
* Query case definitions.
*/
CaseDefinitionQuery createCaseDefinitionQuery();
/**
* Query decision definitions.
*/
DecisionDefinitionQuery createDecisionDefinitionQuery();
/**
* Query decision requirements definition.
*/
DecisionRequirementsDefinitionQuery createDecisionRequirementsDefinitionQuery();
/**
* Query process definitions.
*/
DeploymentQuery createDeploymentQuery();
/**
* 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 {@link #updateProcessDefinitionSuspensionState()}.
*
* @throws ProcessEngineException
* If no such processDefinition can be found.
* @throws AuthorizationException
* If the user has none of the following:
* {@link ProcessDefinitionPermissions#SUSPEND} permission on {@link Resources#PROCESS_DEFINITION}
* {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}
*/
void suspendProcessDefinitionById(String processDefinitionId);
/**
* 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 {@link #updateProcessDefinitionSuspensionState()}.
*
* @param suspendProcessInstances If true, all the process instances of the provided process definition
* will be suspended too.
* @param 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.
* @throws AuthorizationException
* If the user has no {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}.
* and if suspendProcessInstances is set to true and the user has none of the following:
*
* - {@link ProcessInstancePermissions#SUSPEND} permission on {@link Resources#PROCESS_INSTANCE}
* - {@link ProcessDefinitionPermissions#SUSPEND_INSTANCE} permission on {@link Resources#PROCESS_DEFINITION}
* - {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_INSTANCE}
* - {@link Permissions#UPDATE_INSTANCE} permission on {@link Resources#PROCESS_DEFINITION}
*
*
* @see RuntimeService#suspendProcessInstanceById(String)
*/
void suspendProcessDefinitionById(String processDefinitionId, 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: all the process instances of the process definition will still be active
* (ie. not suspended)!
*
* Note: for more complex suspend commands use {@link #updateProcessDefinitionSuspensionState()}.
*
* @throws ProcessEngineException
* If no such processDefinition can be found.
* @throws AuthorizationException
* If the user has none of the following:
* {@link ProcessDefinitionPermissions#SUSPEND} permission on {@link Resources#PROCESS_DEFINITION}
* {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}
*/
void suspendProcessDefinitionByKey(String processDefinitionKey);
/**
* 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 {@link #updateProcessDefinitionSuspensionState()}.
*
* @param suspendProcessInstances If true, all the process instances of the provided process definition
* will be suspended too.
* @param 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.
* @throws AuthorizationException
* If the user has no {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}.
* and if suspendProcessInstances is set to true and the user has none of the following:
*
* - {@link ProcessInstancePermissions#SUSPEND} permission on {@link Resources#PROCESS_INSTANCE}
* - {@link ProcessDefinitionPermissions#SUSPEND_INSTANCE} permission on {@link Resources#PROCESS_DEFINITION}
* - {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_INSTANCE}
* - {@link Permissions#UPDATE_INSTANCE} permission on {@link Resources#PROCESS_DEFINITION}
*
*
* @see RuntimeService#suspendProcessInstanceById(String)
*/
void suspendProcessDefinitionByKey(String processDefinitionKey, boolean suspendProcessInstances, Date suspensionDate);
/**
* Activates the process definition with the given id.
*
* Note: for more complex activate commands use {@link #updateProcessDefinitionSuspensionState()}.
*
* @throws ProcessEngineException
* If no such processDefinition can be found or if the process definition is already in state active.
* @throws AuthorizationException
* If the user has none of the following:
* {@link ProcessDefinitionPermissions#SUSPEND} permission on {@link Resources#PROCESS_DEFINITION}
* {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}
*/
void activateProcessDefinitionById(String processDefinitionId);
/**
* Activates the process definition with the given id.
*
* Note: for more complex activate commands use {@link #updateProcessDefinitionSuspensionState()}.
*
* @param suspendProcessInstances If true, all the process instances of the provided process definition
* will be activated too.
* @param 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.
* @throws AuthorizationException
* If the user has no {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}.
* and if suspendProcessInstances is set to true and the user has none of the following:
*
* - {@link ProcessInstancePermissions#SUSPEND} permission on {@link Resources#PROCESS_INSTANCE}
* - {@link ProcessDefinitionPermissions#SUSPEND_INSTANCE} permission on {@link Resources#PROCESS_DEFINITION}
* - {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_INSTANCE}
* - {@link Permissions#UPDATE_INSTANCE} permission on {@link Resources#PROCESS_DEFINITION}
*
*
* @see RuntimeService#activateProcessInstanceById(String)
*/
void activateProcessDefinitionById(String processDefinitionId, 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 {@link #updateProcessDefinitionSuspensionState()}.
*
* @throws ProcessEngineException
* If no such processDefinition can be found.
* @throws AuthorizationException
* If the user has none of the following:
* {@link ProcessDefinitionPermissions#SUSPEND} permission on {@link Resources#PROCESS_DEFINITION}
* {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}
*/
void activateProcessDefinitionByKey(String processDefinitionKey);
/**
* Activates the process definition with the given key (=id in the bpmn20.xml file).
*
* Note: for more complex activate commands use {@link #updateProcessDefinitionSuspensionState()}.
*
* @param suspendProcessInstances If true, all the process instances of the provided process definition
* will be activated too.
* @param 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.
* @throws AuthorizationException
* If the user has no {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}.
* and if suspendProcessInstances is set to true and the user has none of the following:
*
* - {@link ProcessInstancePermissions#SUSPEND} permission on {@link Resources#PROCESS_INSTANCE}
* - {@link ProcessDefinitionPermissions#SUSPEND_INSTANCE} permission on {@link Resources#PROCESS_DEFINITION}
* - {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_INSTANCE}
* - {@link Permissions#UPDATE_INSTANCE} permission on {@link Resources#PROCESS_DEFINITION}
*
*
* @see RuntimeService#activateProcessInstanceById(String)
*/
void activateProcessDefinitionByKey(String processDefinitionKey, boolean activateProcessInstances, Date activationDate);
/**
* 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 call
* {@link UpdateProcessDefinitionSuspensionStateBuilder#activate()} or
* {@link UpdateProcessDefinitionSuspensionStateBuilder#suspend()}.
*
* @return the builder to update the suspension state
*/
UpdateProcessDefinitionSuspensionStateSelectBuilder updateProcessDefinitionSuspensionState();
/**
* Updates time to live of process definition. The field is used within history cleanup process.
* @param processDefinitionId The id of the process definition to update
* @param historyTimeToLive the value of history time to live to update
* @throws AuthorizationException
* If the user has no {@link Permissions#UPDATE} permission on {@link Resources#PROCESS_DEFINITION}.
* @throws NotAllowedException in case feature flag {@code enforceHistoryTimeToLive} is set to {@code true} and the given historyTimeToLive value is {@code null}.
*/
void updateProcessDefinitionHistoryTimeToLive(String processDefinitionId, Integer historyTimeToLive);
/**
* Updates time to live of decision definition. The field is used within history cleanup process.
*
* @param decisionDefinitionId The id of the decision definition to update
* @param historyTimeToLive the value of history time to live to update
* @throws AuthorizationException If the user has no {@link Permissions#UPDATE} permission on {@link Resources#DECISION_DEFINITION}.
* @throws NotAllowedException in case feature flag {@code enforceHistoryTimeToLive} is set to {@code true} and the given historyTimeToLive value is {@code null}.
*/
void updateDecisionDefinitionHistoryTimeToLive(String decisionDefinitionId, Integer historyTimeToLive);
/**
* Updates time to live of case definition. The field is used within history cleanup process.
*
* @param caseDefinitionId The given case definition id to update
* @param historyTimeToLive the value of history time to live to update
* @throws NotAllowedException in case feature flag {@code enforceHistoryTimeToLive} is set to true and the given historyTimeToLive value is {@code null}.
*/
void updateCaseDefinitionHistoryTimeToLive(String caseDefinitionId, Integer historyTimeToLive);
/**
* Gives access to a deployed process model, e.g., a BPMN 2.0 XML file,
* through a stream of bytes.
*
* @param processDefinitionId
* id of a {@link ProcessDefinition}, cannot be null.
*
* @throws NotFoundException
* when the process model doesn't exist.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#PROCESS_DEFINITION}.
*/
InputStream getProcessModel(String processDefinitionId);
/**
* Gives access to a deployed process diagram, e.g., a PNG image, through a
* stream of bytes.
*
* @param processDefinitionId
* id of a {@link ProcessDefinition}, cannot be null.
* @return null when the diagram resource name of a {@link ProcessDefinition} is null.
*
* @throws ProcessEngineException
* when the process diagram doesn't exist.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#PROCESS_DEFINITION}.
*/
InputStream getProcessDiagram(String processDefinitionId);
/**
* Returns the {@link ProcessDefinition} including all BPMN information like additional
* Properties (e.g. documentation).
*
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#PROCESS_DEFINITION}.
*/
ProcessDefinition getProcessDefinition(String processDefinitionId);
/**
* Provides positions and dimensions of elements in a process diagram as
* provided by {@link RepositoryService#getProcessDiagram(String)}.
*
* This method requires a process model and a diagram image to be deployed.
*
* @param processDefinitionId id of a {@link ProcessDefinition}, cannot be null.
* @return Map with process element ids as keys and positions and dimensions as values.
*
* @return null when the input stream of a process diagram is null.
*
* @throws ProcessEngineException
* When the process model or diagram doesn't exist.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#PROCESS_DEFINITION}.
*/
DiagramLayout getProcessDiagramLayout(String processDefinitionId);
/**
* Returns the {@link BpmnModelInstance} for the given processDefinitionId.
*
* @param processDefinitionId the id of the Process Definition for which the {@link BpmnModelInstance}
* should be retrieved.
*
* @return the {@link BpmnModelInstance}
*
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#PROCESS_DEFINITION}.
*/
BpmnModelInstance getBpmnModelInstance(String processDefinitionId);
/**
* Returns the {@link CmmnModelInstance} for the given caseDefinitionId.
*
* @param caseDefinitionId the id of the Case Definition for which the {@link CmmnModelInstance}
* should be retrieved.
*
* @return the {@link CmmnModelInstance}
*
* @throws NotValidException when the given case definition id or deployment id or resource name is null
* @throws NotFoundException when no CMMN model instance or deployment resource is found for the given
* case definition id
* @throws ProcessEngineException when an internal exception happens during the execution
* of the command.
*/
CmmnModelInstance getCmmnModelInstance(String caseDefinitionId);
/**
* Returns the {@link DmnModelInstance} for the given decisionDefinitionId.
*
* @param decisionDefinitionId the id of the Decision Definition for which the {@link DmnModelInstance}
* should be retrieved.
*
* @return the {@link DmnModelInstance}
*
* @throws NotValidException when the given decision definition id or deployment id or resource name is null
* @throws NotFoundException when no DMN model instance or deployment resource is found for the given
* decision definition id
* @throws ProcessEngineException when an internal exception happens during the execution of the command.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DECISION_DEFINITION}.
*/
DmnModelInstance getDmnModelInstance(String decisionDefinitionId);
/**
* Authorizes a candidate user for a process definition.
*
* @param processDefinitionId id of the process definition, cannot be null.
* @param userId id of the user involve, cannot be null.
*
* @throws ProcessEngineException
* When the process definition or user doesn't exist.
*
* @deprecated Use authorization mechanism instead.
*
*/
@Deprecated
void addCandidateStarterUser(String processDefinitionId, String userId);
/**
* Authorizes a candidate group for a process definition.
*
* @param processDefinitionId id of the process definition, cannot be null.
* @param groupId id of the group involve, cannot be null.
*
* @throws ProcessEngineException
* When the process definition or group doesn't exist.
*
* @deprecated Use authorization mechanism instead.
*
*/
@Deprecated
void addCandidateStarterGroup(String processDefinitionId, String groupId);
/**
* Removes the authorization of a candidate user for a process definition.
*
* @param processDefinitionId id of the process definition, cannot be null.
* @param userId id of the user involve, cannot be null.
*
* @throws ProcessEngineException
* When the process definition or user doesn't exist.
*
* @deprecated Use authorization mechanism instead.
*
*/
@Deprecated
void deleteCandidateStarterUser(String processDefinitionId, String userId);
/**
* Removes the authorization of a candidate group for a process definition.
*
* @param processDefinitionId id of the process definition, cannot be null.
* @param groupId id of the group involve, cannot be null.
*
* @throws ProcessEngineException
* When the process definition or group doesn't exist.
*
* @deprecated Use authorization mechanism instead.
*
*/
@Deprecated
void deleteCandidateStarterGroup(String processDefinitionId, String groupId);
/**
* Retrieves the {@link IdentityLink}s associated with the given process definition.
* Such an {@link IdentityLink} informs how a certain identity (eg. group or user)
* is authorized for a certain process definition
*
* @deprecated Use authorization mechanism instead.
*
*/
@Deprecated
List getIdentityLinksForProcessDefinition(String processDefinitionId);
/**
* Returns the {@link CaseDefinition}.
*
* @throws NotValidException when the given case definition id is null
* @throws NotFoundException when no case definition is found for the given case definition id
* @throws ProcessEngineException when an internal exception happens during the execution
* of the command.
*/
CaseDefinition getCaseDefinition(String caseDefinitionId);
/**
* Gives access to a deployed case model, e.g., a CMMN 1.0 XML file,
* through a stream of bytes.
*
* @param caseDefinitionId
* id of a {@link CaseDefinition}, cannot be null.
*
* @throws NotValidException when the given case definition id or deployment id or resource name is null
* @throws NotFoundException when no case definition or deployment resource is found for the given case definition id
* @throws ProcessEngineException when an internal exception happens during the execution of the command
*/
InputStream getCaseModel(String caseDefinitionId);
/**
* Gives access to a deployed case diagram, e.g., a PNG image, through a
* stream of bytes.
*
* @param caseDefinitionId id of a {@link CaseDefinition}, cannot be null.
* @return null when the diagram resource name of a {@link CaseDefinition} is null.
* @throws ProcessEngineException when the process diagram doesn't exist.
*/
InputStream getCaseDiagram(String caseDefinitionId);
/**
* Returns the {@link DecisionDefinition}.
*
* @throws NotValidException when the given decision definition id is null
* @throws NotFoundException when no decision definition is found for the given decision definition id
* @throws ProcessEngineException when an internal exception happens during the execution of the command.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DECISION_DEFINITION}.
*/
DecisionDefinition getDecisionDefinition(String decisionDefinitionId);
/**
* Returns the {@link DecisionRequirementsDefinition}.
*
* @throws NotValidException when the given decision requirements definition id is null
* @throws NotFoundException when no decision requirements definition is found for the given decision requirements definition id
* @throws ProcessEngineException when an internal exception happens during the execution of the command.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DECISION_REQUIREMENTS_DEFINITION}.
*/
DecisionRequirementsDefinition getDecisionRequirementsDefinition(String decisionRequirementsDefinitionId);
/**
* Gives access to a deployed decision model, e.g., a DMN 1.1 XML file,
* through a stream of bytes.
*
* @param decisionDefinitionId
* id of a {@link DecisionDefinition}, cannot be null.
*
* @throws NotValidException when the given decision definition id or deployment id or resource name is null
* @throws NotFoundException when no decision definition or deployment resource is found for the given decision definition id
* @throws ProcessEngineException when an internal exception happens during the execution of the command
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DECISION_DEFINITION}.
*/
InputStream getDecisionModel(String decisionDefinitionId);
/**
* Gives access to a deployed decision requirements model, e.g., a DMN 1.1 XML file,
* through a stream of bytes.
*
* @param decisionRequirementsDefinitionId
* id of a {@link DecisionRequirementsDefinition}, cannot be null.
*
* @throws NotValidException when the given decision requirements definition id or deployment id or resource name is null
* @throws NotFoundException when no decision requirements definition or deployment resource is found for the given decision requirements definition id
* @throws ProcessEngineException when an internal exception happens during the execution of the command
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DECISION_REQUIREMENTS_DEFINITION}.
*/
InputStream getDecisionRequirementsModel(String decisionRequirementsDefinitionId);
/**
* Gives access to a deployed decision diagram, e.g., a PNG image, through a
* stream of bytes.
*
* @param decisionDefinitionId id of a {@link DecisionDefinition}, cannot be null.
* @return null when the diagram resource name of a {@link DecisionDefinition} is null.
* @throws ProcessEngineException when the decision diagram doesn't exist.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DECISION_DEFINITION}.
*/
InputStream getDecisionDiagram(String decisionDefinitionId);
/**
* Gives access to a deployed decision requirements diagram, e.g., a PNG image, through a
* stream of bytes.
*
* @param decisionRequirementsDefinitionId id of a {@link DecisionRequirementsDefinition}, cannot be null.
* @return null when the diagram resource name of a {@link DecisionRequirementsDefinition} is null.
* @throws ProcessEngineException when the decision requirements diagram doesn't exist.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#DECISION_REQUIREMENTS_DEFINITION}.
*/
InputStream getDecisionRequirementsDiagram(String decisionRequirementsDefinitionId);
/**
* For the given process, returns a list of {@link CalledProcessDefinition}.
* 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.
* Each {@link CalledProcessDefinition} 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.
*
* @param processDefinitionId id of a {@link ProcessDefinition}
* @return a list of {@link CalledProcessDefinition}.
*
* @throws NotFoundException
* When the process definition doesn't exist.
* @throws AuthorizationException
* If the user has no {@link Permissions#READ} permission on {@link Resources#PROCESS_DEFINITION}.
*/
Collection getStaticCalledProcessDefinitions(String processDefinitionId);
}