|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkflowManager
The primary interface exposing features of the workflow system. A workflow manager is implemented over a process manager. In addition to the underlying process information, it provides global status information on workflow instances, tasks and outcomes. It also affords the creation of WorkflowViews which expose user-specific features of the workflow system, including user views of workflow status and the ability to start new workflow instances and fire task outcomes to existing instances.
ProcessManager
,
WorkflowView
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Method Summary | |
---|---|
java.util.Collection |
getActiveTasks(java.lang.String pSubjectId,
TaskQueryOptions pQueryOptions)
Returns TaskInfos for all the active tasks associated with the given workflow subject. |
java.util.Collection |
getActiveTasks(TaskQueryOptions pQueryOptions)
Returns TaskInfos for all the active tasks associated with all workflow subjects. |
java.util.Collection |
getAllTasks(java.lang.String pSubjectId,
TaskQueryOptions pQueryOptions)
Returns TaskInfos for all the tasks associated with the given workflow subject, including inactive and completed tasks. |
WorkflowView |
getGlobalWorkflowView()
Returns a global WorkflowView which is not associated with any User or Persona. |
ProcessManager |
getProcessManager()
Returns the ProcessManager instance that manages process execution for all the workflows associated with this WorkflowManager. |
WorkflowDescriptor |
getWorkflowDescriptor(java.lang.String pProcessName,
java.lang.String pSegmentName)
Returns a WorkflowDescriptor which describes the workflow, its tasks, and their outcomes, given the workflow's process and segment names. |
WorkflowView |
getWorkflowView(Persona pPersona)
Returns a read-only WorkflowView which exposes the features of the workflow system from the point of view of the given Persona, which can represent an individual, role, group, or organization. |
WorkflowView |
getWorkflowView(User pUser)
Returns a WorkflowView which exposes the features of the workflow system from the point of view of the given User. |
Field Detail |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
java.util.Collection getAllTasks(java.lang.String pSubjectId, TaskQueryOptions pQueryOptions) throws WorkflowException
pSubjectId
- the repository id of the workflow subject for
which all tasks should be returnedpQueryOptions
- a TaskQueryOptions object containing any
additional filtering or sorting criteria; if null, all tasks for
the given subject will be returned
WorkflowException
- if the task information cannot be
obtainedTaskInfo
java.util.Collection getActiveTasks(TaskQueryOptions pQueryOptions) throws WorkflowException
pQueryOptions
- a TaskQueryOptions object containing any
additional filtering or sorting criteria; if null, all active
tasks will be returned
WorkflowException
- if the task information cannot be
obtainedTaskInfo
java.util.Collection getActiveTasks(java.lang.String pSubjectId, TaskQueryOptions pQueryOptions) throws WorkflowException
pSubjectId
- the repository id of the workflow subject for
which active tasks should be returnedpQueryOptions
- a TaskQueryOptions object containing any
additional filtering or sorting criteria; if null, all active
tasks for the given subject will be returned
WorkflowException
- if the task information cannot be
obtainedTaskInfo
WorkflowDescriptor getWorkflowDescriptor(java.lang.String pProcessName, java.lang.String pSegmentName)
pProcessName
- the name of the workflow processpSegmentName
- the name of the workflow process segment
WorkflowConstants.DEFAULT_WORKFLOW_SEGMENT
WorkflowView getWorkflowView(User pUser)
WorkflowView getWorkflowView(Persona pPersona)
This type of view can be used, for example, to access workflow information which is available to all the users with a particular role, or in a particular organization. Because this view does not represent an actual User effecting workflow state, it provides read-only access to workflow objects.
WorkflowView getGlobalWorkflowView()
This view is provided as a convenient shortcut for unconstrained access of the workflow system. It can be used, for example, when dealing with types of workflow which do not require access control, or simply as a way to obtain complete workflow information which is not constrained by any user's access rights.
ProcessManager getProcessManager()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |