public interface ProcessDefinitionService
Modifier and Type | Method and Description |
---|---|
ProcessDefinitionInfo |
activateProcessDefinition(String id)
Activates the latest deployed version of the process flow 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)
Deploys the process flow definition file from the repository.
|
List<ProcessDefinitionInfo> |
getAllProcessDefinitions()
Gets all of the latest deployed process flow definitions.
|
ProcessDefinitionInfo |
getProcessDefinitionById(String id)
Gets the latest deployed version of the process flow definition by the specified identifier.
|
List<ProcessDefinitionInfo> |
getProcessDefinitionsByContextType(String contextTypeId)
Gets the latest deployed process flow definitions at the context with the context type.
|
ProcessDefinitionInfo |
suspendProcessDefinition(String id)
Suspends the latest deployed version of the process flow 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 flow definitions.ProcessFlowException
- Thrown when there is an issue getting the process flow definitions.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
process flow definition is deployed but in a suspended state, which means no process flows can be created from
that process flow definition until it is activated.path
- The path of the process flow definition file.version
- The version of the process flow definition file.contextTypeIds
- The context type identifiers in which to make process flow definition available.comment
- The comment that is associated with the deployment action of the process flow definition.activate
- Indicates whether to activate the process flow definition so that process flows can be created
from it.overwrite
- Whether to overwrite the existing process flow definition with the new version.ProcessFlowDeploymentException
- Thrown when there is an issue deploying the process flow definition file.ProcessDefinitionDeploymentException
ProcessDefinitionInfo activateProcessDefinition(String id) throws ProcessDefinitionStateException, ProcessDefinitionNotFoundException
id
- The identifier of the process flow definition.ProcessDefinitionStateException
- Thrown when the process flow definition is currently activated.ProcessDefinitionNotFoundException
- Thrown when the process flow definition with the specified identifier
is not found.ProcessDefinitionInfo getProcessDefinitionById(String id) throws ProcessDefinitionNotFoundException
id
- The identifier of the process flow definition.ProcessDefinitionNotFoundException
- Thrown when the process flow definition with the specified identifier
is not found.ProcessDefinitionInfo suspendProcessDefinition(String id) throws ProcessDefinitionStateException, ProcessDefinitionNotFoundException
id
- The identifier of the process flow definition.ProcessDefinitionStateException
- Thrown when the process flow definition is currently suspended.ProcessDefinitionNotFoundException
- Thrown when the process flow definition with the specified identifier
is not found.Copyright (c) 2020, SAS Institute Inc., Cary, NC, USA