WorkflowManagement
This interface describes the facilities available to external applications using the Workflow Management
System.
Users get access to an implementation of this interface using the getApi() method of the Workflow
interface.
Once an instance of the singleton implementation is acquired a number of separate methods allow the user to
query and modify the overall state of the workflow system. All of the workflow tools, such as the Workflow
Administrator are written using this API.
Many of the methods here use one or other of the descriptor classes to identify the particular enactment, or job, etc.,
that is the target of the method. Typically, these descriptors are returned from other methods available through
this interface. In those situations where a descriptor must be retained by client code the descriptor objects
provide a facility to acquire a handle to the descriptor, which is essentially a stringified form of the descriptor
object itself.
WorkflowManagement Functions
| activateProcess | WorkflowManagement.activateProcess( processName , reason , caller ) | |
| assign | WorkflowManagement.assign( taskEnactmentDescriptor , actorId , onlyIfUnassigned , reason , caller ) | Assign a particular actor to the denoted task enactment |
| assign | WorkflowManagement.assign( taskEnactmentDescriptorId , actorId , onlyIfUnassigned , reason , caller ) | Assign a particular actor to the denoted task enactment using a stringified identifier |
| cancel | WorkflowManagement.cancel( taskEnactmentDescriptor , reason , caller ) | Moves the identified task to the cancelled state. |
| cancel | WorkflowManagement.cancel( taskEnactmentDescriptor , reason , caller ) | Moves the identified task to the cancelled state. |
| cancelJob | WorkflowManagement.cancelJob( jobDescriptor , reason , caller ) | Cancels a currently executing job |
| cancelJob | WorkflowManagement.cancelJob( jobDescriptor , reason , caller ) | Cancels a currently executing job |
| complete | WorkflowManagement.complete( taskEnactmentDescriptor , completionState , reason , caller ) | Notifies a Job that one of its constituent enactments has been completed with the given completion state. |
| complete | WorkflowManagement.complete( taskEnactmentDescriptor , completionState , reason , caller ) | Notifies a Job that one of its constituent enactments has been completed with the given completion state. |
| complete | WorkflowManagement.complete( taskEnactmentDescriptor , completionState , outParams , reason , caller ) | Notifies a Job that one of its constituent enactments has been completed with the given completion state. |
| complete | WorkflowManagement.complete( taskEnactmentDescriptor , completionState , outParams , reason , caller ) | Notifies a Job that one of its constituent enactments has been completed with the given completion state. |
| descriptionOf | WorkflowManagement.descriptionOf( taskEnactmentDescriptor , caller ) | Answers the description of the denoted task enactment |
| descriptionOf | WorkflowManagement.descriptionOf( taskEnactmentDescriptor , language , caller ) | Answers the description of the denoted task enactment |
| descriptorFor | WorkflowManagement.descriptorFor( taskEnactmentDescriptor , language , caller ) | Re-get the execution descriptor for the defined task. |
| descriptorFor | WorkflowManagement.descriptorFor( taskEnactmentDescriptorId , language , caller ) | Re-get the execution descriptor for the defined task. |
| forceAssign | WorkflowManagement.forceAssign( taskEnactmentDescriptor , actorId , reason , caller ) | Assign a particular actor to the denoted task enactment, forcing the assignment to be accepted, if the supplied actor exists, by the underlying assignment handler |
| forceAssign | WorkflowManagement.forceAssign( taskEnactmentDescriptorId , actorId , reason , caller ) | Assign a particular actor to the denoted task enactment using a stringified identifier, forcing the assignment to be accepted, if the supplied actor exists, by the underlying assignment handler |
| forceCompletion | WorkflowManagement.forceCompletion( fallibleDescriptor , reason , caller ) | Force the completion of a previously failed node enactment. |
| forceCompletion | WorkflowManagement.forceCompletion( fallibleDescriptor , reason , caller ) | Force the completion of a previously failed node enactment. |
| getCandidateActors | WorkflowManagement.getCandidateActors( taskEnactmentDescriptor , caller ) | Answers a collection of the possible actor assignments to the identified task enactment |
| getCandidateActors | WorkflowManagement.getCandidateActors( taskEnactmentDescriptorId , caller ) | Answers a collection of the possible actor assignments to the identified task enactment |
| getFailedNodes | WorkflowManagement.getFailedNodes( language , caller ) | Answers a list of FallibleEnactmentDescriptors, each of which describes a particular failed system task. |
| getFilteredAuditRecords | WorkflowManagement.getFilteredAuditRecords( processName , jobId , taskId , level , auditCaller , reason , source , loggedBefore , loggedAfter , maxRecords , language , caller ) | Answer a list of Audit objects which meet the supplied filter criteria. |
| getFilteredJobs | WorkflowManagement.getFilteredJobs( jobId , process , opener , owner , finished , creationDateFrom , creationDateTo , modifiedDateFrom , modifiedDateTo , processAttributes , ignoreSubJobs , includeStepMode , language , caller ) | Answer a list of implementations of the JobDescriptor interface, each of which describes a current job in the system that meets the supplied filter criteria |
| getFilteredPendingEscalators | WorkflowManagement.getFilteredPendingEscalators( escalatedNodeName , escalatedEnactment , contingentEnactment , jobDescriptor , processName , actorId , dueBefore , dueAfter , waiting , active , completed , cancelled , skipped , language , caller ) | Answer a list of implementations of the EscalatorEnactmentDescriptors interface, each of which describes a current extant escalator in the system that meets the supplied filter criteria. |
| getFilteredTasks | WorkflowManagement.getFilteredTasks( nodeClass , taskId , jobId , processName , actorId , assignableToActor , includeActorTasks , includePooledTasks , assignableToRole , unassigned , waiting , active , paused , completed , cancelled , failed , skipped , language , caller ) | Finds out the extant interactive node enactments which meet the supplied filter criteria. |
| getJobs | WorkflowManagement.getJobs( language , caller ) | Answer the list of all currently executing Jobs, each described by a JobDescriptor. |
| getJobsForOwner | WorkflowManagement.getJobsForOwner( owner , language , caller ) | Answer a list of implementations of the JobDescriptor interface, each of which describes a current job in the system that's owned by the named owner |
| getPendingEscalators | WorkflowManagement.getPendingEscalators( language , caller ) | Answers a list of EscalatorEnactmentDescriptors that list each of the escalators that are currently pending for later firing within the system |
| getProcessAttributeValue | WorkflowManagement.getProcessAttributeValue( jobDescriptor , name , caller ) | Gets the value for the named process attribute in the context of the defined job |
| getProcessAttributeValue | WorkflowManagement.getProcessAttributeValue( jobDescriptor , name , caller ) | Gets the value for the named process attribute. |
| getProcessAttributeValues | WorkflowManagement.getProcessAttributeValues( jobDescriptor , caller ) | Answers a map of process attribute names agains their current runtime values. |
| getProcessDescription | WorkflowManagement.getProcessDescription( processName , language , caller ) | Answers the description of the named process. |
| getProcesses | WorkflowManagement.getProcesses( name , quiescent , owner , creator , deleted , caller , language ) | Answer the list of all latest process versions matching the supplied filter criteria each described by a ProcessDescriptor. |
| getProcessInParameters | WorkflowManagement.getProcessInParameters( processName , caller ) | Returns a list of input parameter names for the given process. |
| getTasks | WorkflowManagement.getTasks( jobDescriptor , language , caller ) | Finds out the extant interactive task enactments for a given job. |
| getTasks | WorkflowManagement.getTasks( jobDescriptor , language , caller ) | Finds out the extant interactive task enactments for a given job using a stringified descriptor. |
| getTasksForActor | WorkflowManagement.getTasksForActor( actor , unassigned , language , caller ) | Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist. |
| getTasksForActor | WorkflowManagement.getTasksForActor( actor , language , caller ) | Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist. |
| getTasksForRole | WorkflowManagement.getTasksForRole( role , unassigned , language , caller ) | Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist. |
| open | WorkflowManagement.open( processName , opener , owner , reason , caller ) | Starts a new job on an existing process, defining the owner of the job |
| open | WorkflowManagement.open( processName , opener , owner , inParams , reason , caller ) | Starts a new job on an existing process, supplying the input parameters |
| openedJobs | WorkflowManagement.openedJobs( opener , caller , language ) | Answer the list of currently executing Jobs that were opened by the defined user. |
| openJobAndCompleteFirstTask | WorkflowManagement.openJobAndCompleteFirstTask( processName , opener , owner , taskName , completionState , jobInParams , firstTaskOutParams , language , reason , caller ) | Starts a new job on an existing process and signals that the first interactive task, which must be uniquely determinable, has been completed with the supplied completion state. |
| openTask | WorkflowManagement.openTask( taskEnactmentDescriptor , language , reason , caller ) | Open an assigned task. |
| openTask | WorkflowManagement.openTask( taskEnactmentDescriptorId , language , reason , caller ) | Open an assigned task. |
| pause | WorkflowManagement.pause( taskEnactmentDescriptor , reason , caller ) | Sets the identified task to the paused state. |
| pause | WorkflowManagement.pause( taskEnactmentDescriptor , reason , caller ) | Sets the identified task to the paused state. |
| post | WorkflowManagement.post( jobDescriptor , eventId , reason , caller ) | Posts a waiting pause node enactment with the corresponding event id. |
| post | WorkflowManagement.post( jobDescriptor , eventId , reason , caller ) | Posts the pause node enactment with the specified job and event id as complete. |
| post | WorkflowManagement.post( process , processAttributes , eventId , reason , caller ) | Posts the pause node enactment with the corresponding event id as complete. |
| quiesceProcess | WorkflowManagement.quiesceProcess( processName , reason , caller ) | |
| reexecute | WorkflowManagement.reexecute( fallibleDescriptor , reason , caller ) | Re-execute a previously failed node enactment. |
| reexecute | WorkflowManagement.reexecute( fallibleDescriptor , reason , caller ) | Re-execute a previously failed node enactment. |
| reinstateProcess | WorkflowManagement.reinstateProcess( processName , reason , caller ) | |
| setJobOwner | WorkflowManagement.setJobOwner( jobDescriptor , actorId , reason , caller ) | Assign a particular owner to the denoted job |
| setOutputParameter | WorkflowManagement.setOutputParameter( taskEnactmentdescriptor , name , value , reason , caller ) | Sets a value for the named activity output parameter to be used in subsequent processing. |
| setOutputParameter | WorkflowManagement.setOutputParameter( taskEnactmentdescriptor , name , value , reason , caller ) | Sets a value for the named activity output parameter to be used in subsequent processing. |
| setOutputParameters | WorkflowManagement.setOutputParameters( taskEnactmentDescriptor , outParams , reason , caller ) | Sets the values for the named activity output parameters to be used in subsequent processing. |
| setOutputParameters | WorkflowManagement.setOutputParameters( taskEnactmentDescriptor , outParams , reason , caller ) | Sets the values for the named activity output parameters to be used in subsequent processing. |
| setPriority | WorkflowManagement.setPriority( taskEnactmentDescriptor , priority , reason , caller ) | Changes the priority of the identified task enactment. |
| setPriority | WorkflowManagement.setPriority( taskEnactmentDescriptor , priority , reason , caller ) | Changes the priority of the identified task enactment. |
| setProcessAttributeValue | WorkflowManagement.setProcessAttributeValue( jobDescriptor , name , value , reason , caller ) | Sets the value for the named process attribute. |
| setProcessAttributeValue | WorkflowManagement.setProcessAttributeValue( jobDescriptor , name , value , reason , caller ) | Sets the value for the named process attribute. |
| setWaiting | WorkflowManagement.setWaiting( taskEnactmentDescriptor , reason , caller ) | Sets the identified task to the waiting state. |
| setWaiting | WorkflowManagement.setWaiting( taskEnactmentDescriptor , reason , caller ) | Sets the identified task to the waiting state. |
| stateOf | WorkflowManagement.stateOf( enactmentDescriptor , caller ) | Answers the state of the described task enactment. |
| stateOf | WorkflowManagement.stateOf( enactmentDescriptor , caller ) | Answers the state of the described task enactment. |
| unassign | WorkflowManagement.unassign( taskEnactmentDescriptor , reason , caller ) | Remove any current actor assignment to the identified task. |
| unassign | WorkflowManagement.unassign( taskEnactmentDescriptor , reason , caller ) | Remove any current actor assignment to the identified task. |
| unpause | WorkflowManagement.unpause( taskEnactmentDescriptor , reason , caller ) | Moves the identified task from the paused state. |
| unpause | WorkflowManagement.unpause( taskEnactmentDescriptor , reason , caller ) | Moves the identified task from the paused state. |
| unsetJobOwner | WorkflowManagement.unsetJobOwner( jobDescriptor , reason , caller ) | Clears the owner for the denoted job. |