public interface ProcessFlowService
A process flow is a collection of tasks and elements that can be assigned or executed based on the underlying process definition. A process flow is identified by a name and context, and is associated with and scoped to a context in which it is defined. Examples of a process flow context are organization, project and analysis.
Modifier and Type | Method and Description |
---|---|
ProcessFlow |
activateProcessFlow(String id)
Activates the specified process flow.
|
ProcessFlow |
createProcessFlow(String contextId,
String processFlowName,
String processDefinitionId)
Creates process flow at the context with the name using the latest deployed version of the
process definition with the identifier.
|
String |
createProcessFlowManifest(String id,
FileCreateInfo manifestFileCreateInfo)
Creates a process flow manifest for the process flow with the identifier.
|
void |
deleteProcessFlow(String id)
Deletes the process flow with the identifier.
|
boolean |
exists(String contextId,
String processFlowName)
Indicates whether the process flow exists with the name at the context.
|
Set<ProcessFlowDescriptor> |
getAllProcessFlowDescriptors()
Gets all process flows that the user is authorized to see.
|
Set<ProcessFlowDescriptor> |
getMyProcessFlowDescriptors()
Gets all of the process flows that the user is authorized to see.
|
Set<ProcessFlowDescriptor> |
getMyProcessFlowDescriptorsByContext(String contextId,
boolean includeChildren)
Gets all of the process flows that are owned by the current user at a context, and (optionally) below.
|
ProcessFlow |
getProcessFlowById(String id)
Gets process flow with the identifier.
|
ProcessFlow |
getProcessFlowByNameAndContext(String contextId,
String processFlowName)
Gets process flow with the name at the context.
|
Set<ProcessFlowDescriptor> |
getProcessFlowDescriptorsByContext(String contextId,
boolean includeChildren)
Gets the process flows at the context and (optionally) below.
|
ProcessFlow |
suspendProcessFlow(String id)
Suspends the specified process flow.
|
ProcessFlow |
updateProcessFlow(ProcessFlow processFlow)
Updates the process flow.
|
Set<ProcessFlowDescriptor> getProcessFlowDescriptorsByContext(String contextId, boolean includeChildren) throws ProcessFlowContextNotFoundException
contextId
- the identifier of the context.includeChildren
- indicates whether the context children's process flows are retrieved.ProcessFlowContextNotFoundException
Set<ProcessFlowDescriptor> getAllProcessFlowDescriptors()
Set<ProcessFlowDescriptor> getMyProcessFlowDescriptors()
Set<ProcessFlowDescriptor> getMyProcessFlowDescriptorsByContext(String contextId, boolean includeChildren) throws ProcessFlowContextNotFoundException
contextId
- the identifier of the context.includeChildren
- the boolean value indicating if context children's process flows should be retrieved.ProcessFlowContextNotFoundException
boolean exists(String contextId, String processFlowName)
contextId
- the identifier of context.processFlowName
- the name of the process flow.ProcessFlow getProcessFlowByNameAndContext(String contextId, String processFlowName) throws ProcessFlowNotFoundException
contextId
- the identifier of the context.processFlowName
- the name of the process flow.ProcessFlowNotFoundException
- thrown when the process flow with the name does not exist at the specified context.ProcessFlow getProcessFlowById(String id) throws ProcessFlowNotFoundException, ProcessFlowException
id
- the identifier that represents the process flow.ProcessFlowNotFoundException
- thrown when the process flow with the identifier does not exist.ProcessFlowException
- thrown when there is an issue when getting the process flow.ProcessFlow createProcessFlow(String contextId, String processFlowName, String processDefinitionId) throws ProcessFlowExistsException, ProcessDefinitionNotFoundException, ProcessFlowContextNotFoundException
contextId
- the identifier of the context in which to create the process flow.processFlowName
- the name of the process flow.processDefinitionId
- The identifier of the process definition. This is the process identifier value in the process
definition file.ProcessFlowExistsException
- thrown when a process flow with the name exists in the context.ProcessDefinitionNotFoundException
- thrown when a deployed process definition does not exist with the
identifier in the context.ProcessFlowContextNotFoundException
- thrown when the process flow context does not exist.ProcessFlow updateProcessFlow(ProcessFlow processFlow) throws ProcessFlowNotFoundException, InvalidProcessFlowStateException, ProcessFlowException, ProcessFlowExistsException
processFlow
- the process flow.ProcessFlowNotFoundException
- thrown when the process flow with the identifier does not exist.InvalidProcessFlowStateException
- thrown when the process flow is in an invalid state to update the
process flow.ProcessFlowException
- thrown when there is an issue updating the process flow.ProcessFlowExistsException
- thrown when a process flow with the name exists at the context.void deleteProcessFlow(String id) throws ProcessFlowNotFoundException, ProcessFlowException
id
- the identifier of the process flow.ProcessFlowNotFoundException
- thrown when the process flow with the identifier does not exist at the context.ProcessFlowException
- thrown when there is an issue deleting the process flow.String createProcessFlowManifest(String id, FileCreateInfo manifestFileCreateInfo) throws ProcessFlowNotFoundException, ProcessFlowManifestCreateException, ProcessFlowException
id
- the identifier of the process flow.manifestFileCreateInfo
- the method to add the new process flow manifest file (such as major version or
minor version). Specifying null defaults to a major version.ProcessFlowNotFoundException
- thrown when the process flow with the identifier does not exist at the context.ProcessFlowManifestCreateException
- thrown when there is an issue creating a process flow manifest file for the
process flow.ProcessFlowException
- thrown when there is an issue creating the process flow manifest file.ProcessFlow activateProcessFlow(String id) throws ProcessFlowNotFoundException, ProcessFlowException
id
- the identifier of the process flow.ProcessFlowNotFoundException
- thrown when the process flow with the identifier does not exist.ProcessFlowException
- thrown when there is an issue activating the process flow.ProcessFlow suspendProcessFlow(String id) throws ProcessFlowNotFoundException, ProcessFlowException
id
- the identifier of the process flow.ProcessFlowNotFoundException
- thrown when the process flow with the identifier does not exist.ProcessFlowException
- thrown when there is an issue suspending the process flow.Copyright (c) 2019, SAS Institute Inc., Cary, NC, USA