public interface ProcessDefinitionService
Modifier and Type | Method and Description |
---|---|
ProcessDefinitionInfo |
activateProcessDefinition(String id)
Activates the latest deployed version of the process definition so that process flows can be created from it.
|
ProcessDefinitionInfo |
deployProcessDefinitionFromRepository(String path,
String version,
Set<String> contextTypeIds,
String comment,
boolean activate,
boolean overwrite)
Deploy the process definition file from the repository.
|
List<ProcessDefinitionInfo> |
getAllProcessDefinitions()
Gets all of the latest deployed process definitions in the system.
|
ProcessDefinitionInfo |
getProcessDefinitionById(String id)
Gets the latest deployed version of the process definition by the specified id.
|
List<ProcessDefinitionInfo> |
getProcessDefinitionsByContextType(String contextTypeId)
Gets the latest deployed process definitions at the context with the context type.
|
ProcessDefinitionInfo |
suspendProcessDefinition(String id)
Suspends the latest deployed version of the process definition so that process flows cannot be created from it.
|
List<ProcessDefinitionInfo> getProcessDefinitionsByContextType(String contextTypeId) throws ProcessFlowException
contextTypeId
- The context type identifier for which to get the process definitions.ProcessFlowException
- Thrown when there is an issue getting the process definitions from the system.List<ProcessDefinitionInfo> getAllProcessDefinitions()
ProcessDefinitionInfo deployProcessDefinitionFromRepository(String path, String version, Set<String> contextTypeIds, String comment, boolean activate, boolean overwrite) throws ProcessDefinitionDeploymentException
activate
is specified as false, the
definition will be deployed but in a suspended state which means no process flows can be created from that
definition until it is activated.path
- The path of the process definition file in the repository.version
- The version of the process definition file in the repository.contextTypeIds
- The context type identifiers in which to make process definition available.comment
- The comment associated to the deploy action of the process definition.activate
- Whether to activate the process definition so that process flows may be created from it.overwrite
- Whether to overwrite the existing process definition with this new version.ProcessFlowDeploymentException
- Thrown when there is an issue deploying the process definition file.ProcessDefinitionDeploymentException
ProcessDefinitionInfo activateProcessDefinition(String id) throws ProcessDefinitionStateException, ProcessDefinitionNotFoundException
id
- The id of the process definition.ProcessDefinitionStateException
- Thrown if the process definition is already activated.ProcessDefinitionNotFoundException
- Thrown if the process definition with the specified id could not be
found.ProcessDefinitionInfo getProcessDefinitionById(String id) throws ProcessDefinitionNotFoundException
id
- The id of the process definition.ProcessDefinitionNotFoundException
- Thrown if the process definition with the specified id could not be
found.ProcessDefinitionInfo suspendProcessDefinition(String id) throws ProcessDefinitionStateException, ProcessDefinitionNotFoundException
id
- The id of the process definition.ProcessDefinitionStateException
- Thrown if the process definition is already suspended.ProcessDefinitionNotFoundException
- Thrown if the process definition with the specified id could not be
found.Copyright (c) 2019, SAS Institute Inc., Cary, NC, USA