Package com.ebasetech.xi.api.workflow

Interface WorkflowManagement

public interface 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.
See Also:
Workflow.getApi(), WorkflowManagement.FallibleEnactmentDescriptor, WorkflowManagement.FallibleEnactmentDescriptor.getIdentifier(), WorkflowManagement.DecisionEnactmentDescriptor, WorkflowManagement.FallibleEnactmentDescriptor.getIdentifier(), WorkflowManagement.TaskEnactmentDescriptor, WorkflowManagement.FallibleEnactmentDescriptor.getIdentifier(), WorkflowManagement.InteractiveTaskEnactmentDescriptor, WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

  • Nested Class Summary

    Nested Classes
    Modifier and Type Interface Description
    static interface  WorkflowManagement.DecisionEnactmentDescriptor
    An extension that incorporates the notion of a script
    static interface  WorkflowManagement.EscalatorEnactmentDescriptor
    An extension that describes the enactment of an escalator
    static interface  WorkflowManagement.FallibleEnactmentDescriptor
    This descriptor is used to represent descriptions of those enactments that implement the Fallible interface and therefore capable of failing at enactment time.
    static interface  WorkflowManagement.InteractiveTaskEnactmentDescriptor
    Implementations of this interface provide the detailed information needed by the tasklist application.
    static interface  WorkflowManagement.JobDescriptor
    Implementations of this interface provide information about a Job in the system
    static interface  WorkflowManagement.PauseEnactmentDescriptor
    An extension that incorporates the notion of a script and an event id
    static interface  WorkflowManagement.SystemTaskEnactmentDescriptor
    A descriptor used purely for System tasks
    static interface  WorkflowManagement.TaskEnactmentDescriptor
    An extension that incorporates the notion of an associated task

  • Method Summary

    Modifier and Type Method Description
    void activateProcess​(java.lang.String processName, java.lang.String reason, java.lang.String caller)
    Deprecated.
    From V5.0 this method takes no action and is treated as a no-op
    void assign​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String actorId, boolean onlyIfUnassigned, java.lang.String reason, java.lang.String caller)
    Assign a particular actor to the denoted task enactment
    void assign​(java.lang.String taskEnactmentDescriptorId, java.lang.String actorId, boolean onlyIfUnassigned, java.lang.String reason, java.lang.String caller)
    Assign a particular actor to the denoted task enactment using a stringified identifier
    void cancel​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Moves the identified task to the cancelled state.
    void cancel​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Moves the identified task to the cancelled state.
    void cancelJob​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String reason, java.lang.String caller)
    Cancels a currently executing job
    void cancelJob​(java.lang.String jobDescriptor, java.lang.String reason, java.lang.String caller)
    Cancels a currently executing job
    void complete​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String completionState, java.lang.String reason, java.lang.String caller)
    Notifies a Job that one of its constituent enactments has been completed with the given completion state.
    void complete​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String completionState, java.util.Map outParams, java.lang.String reason, java.lang.String caller)
    Notifies a Job that one of its constituent enactments has been completed with the given completion state.
    void complete​(java.lang.String taskEnactmentDescriptor, java.lang.String completionState, java.lang.String reason, java.lang.String caller)
    Notifies a Job that one of its constituent enactments has been completed with the given completion state.
    void complete​(java.lang.String taskEnactmentDescriptor, java.lang.String completionState, java.util.Map outParams, java.lang.String reason, java.lang.String caller)
    Notifies a Job that one of its constituent enactments has been completed with the given completion state.
    java.lang.String descriptionOf​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String caller)
    Answers the description of the denoted task enactment
    java.lang.String descriptionOf​(java.lang.String taskEnactmentDescriptor, java.lang.String language, java.lang.String caller)
    Answers the description of the denoted task enactment
    ExecutionDescriptor descriptorFor​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String language, java.lang.String caller)
    Re-get the execution descriptor for the defined task.
    ExecutionDescriptor descriptorFor​(java.lang.String taskEnactmentDescriptorId, java.lang.String language, java.lang.String caller)
    Re-get the execution descriptor for the defined task.
    void forceAssign​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String actorId, java.lang.String reason, java.lang.String 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
    void forceAssign​(java.lang.String taskEnactmentDescriptorId, java.lang.String actorId, java.lang.String reason, java.lang.String 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
    void forceCompletion​(WorkflowManagement.FallibleEnactmentDescriptor fallibleDescriptor, java.lang.String reason, java.lang.String caller)
    Force the completion of a previously failed node enactment.
    void forceCompletion​(java.lang.String fallibleDescriptor, java.lang.String reason, java.lang.String caller)
    Force the completion of a previously failed node enactment.
    java.util.Collection getCandidateActors​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String caller)
    Answers a collection of the possible actor assignments to the identified task enactment
    java.util.Collection getCandidateActors​(java.lang.String taskEnactmentDescriptorId, java.lang.String caller)
    Answers a collection of the possible actor assignments to the identified task enactment
    java.util.List getFailedNodes​(java.lang.String language, java.lang.String caller)
    Answers a list of FallibleEnactmentDescriptors, each of which describes a particular failed system task.
    java.util.List getFilteredAuditRecords​(java.lang.String processName, java.lang.String jobId, java.lang.String taskId, java.lang.Integer level, java.lang.String auditCaller, java.lang.String reason, java.lang.String source, java.util.Date loggedBefore, java.util.Date loggedAfter, int maxRecords, java.lang.String language, java.lang.String caller)
    Answer a list of Audit objects which meet the supplied filter criteria.
    java.util.List getFilteredJobs​(java.lang.String jobId, java.lang.String process, java.lang.String opener, java.lang.String owner, java.lang.Boolean finished, java.util.Date creationDateFrom, java.util.Date creationDateTo, java.util.Date modifiedDateFrom, java.util.Date modifiedDateTo, java.util.Map<java.lang.String,​java.lang.String> processAttributes, boolean ignoreSubJobs, boolean includeStepMode, java.lang.String language, java.lang.String 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
    java.util.List getFilteredPendingEscalators​(java.lang.String escalatedNodeName, java.lang.String escalatedEnactment, java.lang.String contingentEnactment, java.lang.String jobDescriptor, java.lang.String processName, java.lang.String actorId, java.util.Date dueBefore, java.util.Date dueAfter, boolean waiting, boolean active, boolean completed, boolean cancelled, boolean skipped, java.lang.String language, java.lang.String 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.
    java.util.List getFilteredTasks​(java.lang.String nodeClass, java.lang.String taskId, java.lang.String jobId, java.lang.String processName, java.lang.String actorId, java.lang.String assignableToActor, boolean includeActorTasks, boolean includePooledTasks, java.lang.String assignableToRole, boolean unassigned, boolean waiting, boolean active, boolean paused, boolean completed, boolean cancelled, boolean failed, boolean skipped, java.lang.String language, java.lang.String caller)
    Finds out the extant interactive node enactments which meet the supplied filter criteria.
    java.util.List getJobs​(java.lang.String language, java.lang.String caller)
    Answer the list of all currently executing Jobs, each described by a JobDescriptor.
    java.util.List getJobsForOwner​(java.lang.String owner, java.lang.String language, java.lang.String 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
    java.util.List getPendingEscalators​(java.lang.String language, java.lang.String caller)
    Answers a list of EscalatorEnactmentDescriptors that list each of the escalators that are currently pending for later firing within the system
    java.lang.Object getProcessAttributeValue​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String name, java.lang.String caller)
    Gets the value for the named process attribute in the context of the defined job
    java.lang.Object getProcessAttributeValue​(java.lang.String jobDescriptor, java.lang.String name, java.lang.String caller)
    Gets the value for the named process attribute.
    java.util.Map getProcessAttributeValues​(java.lang.String jobDescriptor, java.lang.String caller)
    Answers a map of process attribute names agains their current runtime values.
    java.lang.String getProcessDescription​(java.lang.String processName, java.lang.String language, java.lang.String caller)
    Answers the description of the named process.
    java.util.List getProcesses​(java.lang.String name, java.lang.Boolean quiescent, java.lang.String owner, java.lang.String creator, java.lang.Boolean deleted, java.lang.String caller, java.lang.String language)
    Answer the list of all latest process versions matching the supplied filter criteria each described by a ProcessDescriptor.
    java.util.List getProcessInParameters​(java.lang.String processName, java.lang.String caller)
    Returns a list of input parameter names for the given process.
    java.util.List getTasks​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String language, java.lang.String caller)
    Finds out the extant interactive task enactments for a given job.
    java.util.List getTasks​(java.lang.String jobDescriptor, java.lang.String language, java.lang.String caller)
    Finds out the extant interactive task enactments for a given job using a stringified descriptor.
    java.util.List getTasksForActor​(java.lang.String actor, boolean unassigned, java.lang.String language, java.lang.String caller)
    Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist.
    java.util.List getTasksForActor​(java.lang.String actor, java.lang.String language, java.lang.String caller)
    Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist.
    java.util.List getTasksForRole​(java.lang.String role, boolean unassigned, java.lang.String language, java.lang.String caller)
    Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist.
    WorkflowManagement.JobDescriptor open​(java.lang.String processName, java.lang.String opener, java.lang.String owner, java.lang.String reason, java.lang.String caller)
    Starts a new job on an existing process, defining the owner of the job
    WorkflowManagement.JobDescriptor open​(java.lang.String processName, java.lang.String opener, java.lang.String owner, java.util.Map inParams, java.lang.String reason, java.lang.String caller)
    Starts a new job on an existing process, supplying the input parameters
    java.util.List openedJobs​(java.lang.String opener, java.lang.String caller, java.lang.String language)
    Answer the list of currently executing Jobs that were opened by the defined user.
    WorkflowManagement.JobDescriptor openJobAndCompleteFirstTask​(java.lang.String processName, java.lang.String opener, java.lang.String owner, java.lang.String taskName, java.lang.String completionState, java.util.Map jobInParams, java.util.Map firstTaskOutParams, java.lang.String language, java.lang.String reason, java.lang.String 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.
    ExecutionDescriptor openTask​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String language, java.lang.String reason, java.lang.String caller)
    Open an assigned task.
    ExecutionDescriptor openTask​(java.lang.String taskEnactmentDescriptorId, java.lang.String language, java.lang.String reason, java.lang.String caller)
    Open an assigned task.
    void pause​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Sets the identified task to the paused state.
    void pause​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Sets the identified task to the paused state.
    void post​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String eventId, java.lang.String reason, java.lang.String caller)
    Posts a waiting pause node enactment with the corresponding event id.
    void post​(java.lang.String jobDescriptor, java.lang.String eventId, java.lang.String reason, java.lang.String caller)
    Posts the pause node enactment with the specified job and event id as complete.
    void post​(java.lang.String process, java.util.Map<java.lang.String,​java.lang.String> processAttributes, java.lang.String eventId, java.lang.String reason, java.lang.String caller)
    Posts the pause node enactment with the corresponding event id as complete.
    void quiesceProcess​(java.lang.String processName, java.lang.String reason, java.lang.String caller)
    Deprecated.
    From V5.0 this method takes no action and is treated as a no-op
    void reexecute​(WorkflowManagement.FallibleEnactmentDescriptor fallibleDescriptor, java.lang.String reason, java.lang.String caller)
    Re-execute a previously failed node enactment.
    void reexecute​(java.lang.String fallibleDescriptor, java.lang.String reason, java.lang.String caller)
    Re-execute a previously failed node enactment.
    void reinstateProcess​(java.lang.String processName, java.lang.String reason, java.lang.String caller)
    Deprecated.
    From V5.0 this method takes no action and is treated as a no-op
    void setJobOwner​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String actorId, java.lang.String reason, java.lang.String caller)
    Assign a particular owner to the denoted job
    void setOutputParameter​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentdescriptor, java.lang.String name, java.lang.Object value, java.lang.String reason, java.lang.String caller)
    Sets a value for the named activity output parameter to be used in subsequent processing.
    void setOutputParameter​(java.lang.String taskEnactmentdescriptor, java.lang.String name, java.lang.Object value, java.lang.String reason, java.lang.String caller)
    Sets a value for the named activity output parameter to be used in subsequent processing.
    void setOutputParameters​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.util.Map outParams, java.lang.String reason, java.lang.String caller)
    Sets the values for the named activity output parameters to be used in subsequent processing.
    void setOutputParameters​(java.lang.String taskEnactmentDescriptor, java.util.Map outParams, java.lang.String reason, java.lang.String caller)
    Sets the values for the named activity output parameters to be used in subsequent processing.
    void setPriority​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, int priority, java.lang.String reason, java.lang.String caller)
    Changes the priority of the identified task enactment.
    void setPriority​(java.lang.String taskEnactmentDescriptor, int priority, java.lang.String reason, java.lang.String caller)
    Changes the priority of the identified task enactment.
    void setProcessAttributeValue​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String name, java.lang.Object value, java.lang.String reason, java.lang.String caller)
    Sets the value for the named process attribute.
    void setProcessAttributeValue​(java.lang.String jobDescriptor, java.lang.String name, java.lang.Object value, java.lang.String reason, java.lang.String caller)
    Sets the value for the named process attribute.
    void setWaiting​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Sets the identified task to the waiting state.
    void setWaiting​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Sets the identified task to the waiting state.
    com.ebasetech.ufs.workflow.server.enactment.state.State stateOf​(WorkflowManagement.FallibleEnactmentDescriptor enactmentDescriptor, java.lang.String caller)
    Answers the state of the described task enactment.
    com.ebasetech.ufs.workflow.server.enactment.state.State stateOf​(java.lang.String enactmentDescriptor, java.lang.String caller)
    Answers the state of the described task enactment.
    void unassign​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Remove any current actor assignment to the identified task.
    void unassign​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Remove any current actor assignment to the identified task.
    void unpause​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Moves the identified task from the paused state.
    void unpause​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller)
    Moves the identified task from the paused state.
    void unsetJobOwner​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String reason, java.lang.String caller)
    Clears the owner for the denoted job.

  • Method Details

    • getTasksForActor

      java.util.List getTasksForActor​(java.lang.String actor, boolean unassigned, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist. That is, it is representation of a current InteractiveTaskEnactment that is either in state Unassigned, or is in some other state but has the given actor as the defined specific resource.
      Parameters:
      actor - the actor for which the tasklist is intended
      unassigned - if true, answer all task enactments that are currently in state Unassigned and which could be undertaken by the supplied actor. If false, then only those tasks which have the given actor allocated as their actorId are returned.
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getTasksForActor

      java.util.List getTasksForActor​(java.lang.String actor, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist. This method answers all such tasks, regardless of whether they are currently assigned or not.
      Parameters:
      actor - The actor for which the tasklist is intended
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getFailedNodes

      java.util.List getFailedNodes​(java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers a list of FallibleEnactmentDescriptors, each of which describes a particular failed system task.
      Parameters:
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • reexecute

      void reexecute​(WorkflowManagement.FallibleEnactmentDescriptor fallibleDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Re-execute a previously failed node enactment. That is, the supplied descriptor must previously have been returned from getFailedNodes.
      Parameters:
      fallibleDescriptor - a descriptor of the failed enactment
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      getFailedNodes(String, String), reexecute(String, String, String)

    • reexecute

      void reexecute​(java.lang.String fallibleDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Re-execute a previously failed node enactment. This method uses a string form of the enactment descriptor
      Parameters:
      fallibleDescriptor - a descriptor of the failed enactment, acquired from getIdentifier()
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      reexecute(com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor, String, String), WorkflowManagement.FallibleEnactmentDescriptor.getIdentifier()

    • forceCompletion

      void forceCompletion​(WorkflowManagement.FallibleEnactmentDescriptor fallibleDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Force the completion of a previously failed node enactment. This method is provided so that a user decision may be taken to proceed with the enactment of a process, even though some node enactment has failed.
      Parameters:
      fallibleDescriptor - a descriptor of the failed enactment
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      forceCompletion(String, String, String)

    • forceCompletion

      void forceCompletion​(java.lang.String fallibleDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Force the completion of a previously failed node enactment. This method is provided so that a user decision may be taken to proceed with the enactment of a process, even though some node enactment has failed.
      Parameters:
      fallibleDescriptor - a descriptor of the failed enactment
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      forceCompletion(com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor, String, String), WorkflowManagement.FallibleEnactmentDescriptor.getIdentifier()

    • getTasksForRole

      java.util.List getTasksForRole​(java.lang.String role, boolean unassigned, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers a list of TaskEnactmentDescriptors, each of which describes a particular item which is either on, or could appear on, a users tasklist. That is, it is representation of a current InteractiveTaskEnactment that may be taken up by an actor playing the defined role.
      Parameters:
      language - the language code for the language in use by the caller
      role - The role which is of interest
      unassigned - If true, answer all task enactments that are currently in state Unassigned and which could be taken up by an actor playing the defined role. If false, answer those enactments which could be taken up by an actor playing the defined role and which have already been assigned to a particular actor
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getFilteredTasks

      java.util.List getFilteredTasks​(java.lang.String nodeClass, java.lang.String taskId, java.lang.String jobId, java.lang.String processName, java.lang.String actorId, java.lang.String assignableToActor, boolean includeActorTasks, boolean includePooledTasks, java.lang.String assignableToRole, boolean unassigned, boolean waiting, boolean active, boolean paused, boolean completed, boolean cancelled, boolean failed, boolean skipped, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Finds out the extant interactive node enactments which meet the supplied filter criteria.
      Parameters:
      nodeClass - the class name of the node types for which task enactments are required. If null then all nodes are allowed
      taskId - stringified form of the descriptor for the specific node enactment we're looking for. If null then all enactments are requured
      jobId - stringified form of job for which enactments are required. If null then enactments for all jobs are required.
      processName - name of process for desired enactments, or null if all processes are acceptable
      actorId - name of assigned actor for desired enactments, or null if all are acceptable
      assignableToActor - name of actor to which the desired enactments may successfully assigned, or null if all are acceptable
      includeActorTasks - If true and assignableToActor is set, this will return all tasks which are potentially assignable to the named actor and are not already assigned to another actor.
      includePooledTasks - If true and assignableToActor is set, this will return all tasks which are potentially assignable to the named actor and are not already assigned to another actor.
      assignableToRole - name of role to which the desired enactments may successfully assigned, or null if all are acceptable
      unassigned - if true, return only those enactments that are unassigned. If false, then return all enactments.
      waiting - if true, return only those enactments that are waiting. If false, then return all enactments.
      active - if true, return only those enactments that are active. If false, then return all enactments.
      paused - if true, return only those enactments that are paused. If false, then return all enactments.
      completed - if true, return only those enactments that are completed. If false, then return all enactments.
      cancelled - if true, return only those enactments that are cancelled. If false, then return all enactments.
      failed - if true, return only those enactments that are failed. If false, then return all enactments.
      skipped - if true, return only those enactments that are skipped. If false, then return all enactments.
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getFilteredAuditRecords

      java.util.List getFilteredAuditRecords​(java.lang.String processName, java.lang.String jobId, java.lang.String taskId, java.lang.Integer level, java.lang.String auditCaller, java.lang.String reason, java.lang.String source, java.util.Date loggedBefore, java.util.Date loggedAfter, int maxRecords, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answer a list of Audit objects which meet the supplied filter criteria.
      Parameters:
      processName - the process name for which audit records are required, or null if any process is acceptable.
      jobId - the stringified form of the job descriptor for which records are required, or null if all are acceptable
      taskId - the stringified form of the task descriptor for which records are required, or null if all are acceptable
      level - the level integer for which records are required, or null if all are acceptable
      auditCaller - the caller of the original operation for which records are required, or null if all are acceptable
      reason - the desired reason for which records are required, or null if all are acceptable
      source - the source for which records are required, or null if all are acceptable
      loggedBefore - the date before which records are required, or null if all are acceptable
      loggedAfter - the date after which records are required, or null if all are acceptable
      maxRecords - the maximum number of records to return
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • assign

      void assign​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String actorId, boolean onlyIfUnassigned, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Assign a particular actor to the denoted task enactment
      Parameters:
      taskEnactmentDescriptor - Descriptor of the assignable object that is to be updated
      actorId - The name of the actor to assign to the enactment
      onlyIfUnassigned - If true, this will throw an exception if the task is already assigned
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      assign(String,String,boolean,String,String)

    • assign

      void assign​(java.lang.String taskEnactmentDescriptorId, java.lang.String actorId, boolean onlyIfUnassigned, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Assign a particular actor to the denoted task enactment using a stringified identifier
      Parameters:
      taskEnactmentDescriptorId - Handle of the descriptor of the assignable object that is to be updated
      actorId - The name of the actor to assign to the enactment
      onlyIfUnassigned - If true, this will throw an exception if the task is already assigned
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      assign(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor,String,boolean,String,String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • forceAssign

      void forceAssign​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String actorId, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      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
      Parameters:
      taskEnactmentDescriptor - Descriptor of the assignable object that is to be updated
      actorId - The name of the actor to assign to the enactment
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      assign(String,String,boolean,String,String)

    • forceAssign

      void forceAssign​(java.lang.String taskEnactmentDescriptorId, java.lang.String actorId, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      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
      Parameters:
      taskEnactmentDescriptorId - Handle of the descriptor of the assignable object that is to be updated
      actorId - The name of the actor to assign to the enactment
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      assign(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor,String,boolean,String,String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • openTask

      ExecutionDescriptor openTask​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String language, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Open an assigned task. That is, make the task realise that it's been opened elsewhere as the task is not actually run by this but by the application using the WorkflowManagement API. This can only be called with a caller to whom the task is assigned.
      Parameters:
      taskEnactmentDescriptor - Descriptor of the task enactment to be opened
      language - the language code for the language in use by the caller
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Returns:
      A description of what the invoking application must do to actually run this task
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      openTask(String,String,String,String)

    • openTask

      ExecutionDescriptor openTask​(java.lang.String taskEnactmentDescriptorId, java.lang.String language, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Open an assigned task. That is, make the task realise that it's been opened elsewhere as the task is not actually run by this but by the application using the WorkflowManagement API. This can only be called with a caller to whom the task is assigned.
      Parameters:
      taskEnactmentDescriptorId - Descriptor of the task enactment to be opened, expressed as a string
      language - the language code for the language in use by the caller
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Returns:
      A description of what the invoking application must do to actually run this task
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • descriptorFor

      ExecutionDescriptor descriptorFor​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Re-get the execution descriptor for the defined task. This is used when a user does not get the chance to complete the associated task an must restart it.
      Parameters:
      taskEnactmentDescriptor - Descriptor of the task enactment to be opened
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Returns:
      A description of what the invoking application must do to actually run this task
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      descriptorFor(String,String,String)

    • descriptorFor

      ExecutionDescriptor descriptorFor​(java.lang.String taskEnactmentDescriptorId, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Re-get the execution descriptor for the defined task. This is used when a user does not get the chance to complete the associated task an must restart it.
      Parameters:
      taskEnactmentDescriptorId - String version of the descriptor of the task enactment to be opened
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Returns:
      A description of what the invoking application must do to actually run this task
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      descriptorFor(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • unassign

      void unassign​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Remove any current actor assignment to the identified task. The pool definition remain unchanged.
      Parameters:
      taskEnactmentDescriptor - Handle to the object to be unassigned
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      unassign(String, String, String)

    • unassign

      void unassign​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Remove any current actor assignment to the identified task. The pool definition remain unchanged.
      Parameters:
      taskEnactmentDescriptor - Handle to the object to be unassigned
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      unassign(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String)

    • setWaiting

      void setWaiting​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets the identified task to the waiting state.
      Parameters:
      taskEnactmentDescriptor - descriptor of the enactment to set waiting
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setWaiting(String, String, String)

    • setWaiting

      void setWaiting​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets the identified task to the waiting state.
      Parameters:
      taskEnactmentDescriptor - handle to the descriptor of the enactment to set waiting
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setWaiting(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • pause

      void pause​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets the identified task to the paused state.
      Parameters:
      taskEnactmentDescriptor - descriptor of the enactment to pause
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      pause(String, String, String)

    • pause

      void pause​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets the identified task to the paused state.
      Parameters:
      taskEnactmentDescriptor - handle to the descriptor of the enactment to pause
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      pause(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • unpause

      void unpause​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Moves the identified task from the paused state.
      Parameters:
      taskEnactmentDescriptor - descriptor of the enactment to unpause
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      unpause(String, String, String)

    • unpause

      void unpause​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Moves the identified task from the paused state.
      Parameters:
      taskEnactmentDescriptor - handle to the descriptor of the enactment to unpause
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      unpause(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • cancel

      void cancel​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Moves the identified task to the cancelled state.
      Parameters:
      taskEnactmentDescriptor - descriptor of the enactment to cancel
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      cancel(String, String, String)

    • cancel

      void cancel​(java.lang.String taskEnactmentDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Moves the identified task to the cancelled state.
      Parameters:
      taskEnactmentDescriptor - handle to the descriptor of the enactment to cancel
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      cancel(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • setPriority

      void setPriority​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, int priority, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Changes the priority of the identified task enactment. This does not change the default priority in the task node itself.
      Parameters:
      taskEnactmentDescriptor - descriptor of the target enactment
      priority - new priority for the selected enactment.
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setPriority(String, int, String, String)

    • setPriority

      void setPriority​(java.lang.String taskEnactmentDescriptor, int priority, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Changes the priority of the identified task enactment. This does not change the default priority in the task node itself.
      Parameters:
      taskEnactmentDescriptor - descriptor of the target enactment
      priority - new priority for the selected enactment.
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setPriority(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, int, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • open

      WorkflowManagement.JobDescriptor open​(java.lang.String processName, java.lang.String opener, java.lang.String owner, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Starts a new job on an existing process, defining the owner of the job
      Parameters:
      processName - the name of the process on which to open a job
      opener - the resource who is opening this job
      owner - the resource who owns this job
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • openJobAndCompleteFirstTask

      WorkflowManagement.JobDescriptor openJobAndCompleteFirstTask​(java.lang.String processName, java.lang.String opener, java.lang.String owner, java.lang.String taskName, java.lang.String completionState, java.util.Map jobInParams, java.util.Map firstTaskOutParams, java.lang.String language, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      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. The supplied map of parameters are also provided as the parameters that are set after the task has completed.
      Parameters:
      processName - the name of the process on which to open a job
      opener - the textual name of the person opening the job
      owner -
      taskName - the name of the interactive task that has also been completed
      completionState - the completion state of the denoted task
      jobInParams - the input parameters for the new job or null of there are none
      firstTaskOutParams - the output parameters from the completed task or null if there are none
      language - the language code for the language in use by the caller
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • open

      WorkflowManagement.JobDescriptor open​(java.lang.String processName, java.lang.String opener, java.lang.String owner, java.util.Map inParams, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Starts a new job on an existing process, supplying the input parameters
      Parameters:
      processName - the name of the process on which to open a job
      opener - the resource who is opening this job
      owner - the resource who owns this job or null if there is no specifically defined owner
      inParams - Map of process input parameter names and values
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getProcessInParameters

      java.util.List getProcessInParameters​(java.lang.String processName, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Returns a list of input parameter names for the given process.
      Parameters:
      processName - the name of the process
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getProcesses

      java.util.List getProcesses​(java.lang.String name, java.lang.Boolean quiescent, java.lang.String owner, java.lang.String creator, java.lang.Boolean deleted, java.lang.String caller, java.lang.String language) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answer the list of all latest process versions matching the supplied filter criteria each described by a ProcessDescriptor.
      Parameters:
      name - the name of the process
      quiescent - the required state of the versions, or null if don't care
      owner - the owner of the process versions, or null if don't care
      creator - the creator of the process versions, or null if don't care
      deleted - the state of the versions' deleted flag, or null if don't care
      caller - The id of the user invoking this method
      language - the language code for the language in use by the caller
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • openedJobs

      java.util.List openedJobs​(java.lang.String opener, java.lang.String caller, java.lang.String language) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answer the list of currently executing Jobs that were opened by the defined user. Each member of the result list is described by a JobDescriptor.
      Parameters:
      opener - name of the opener of the result jobs, or null if all jobs are required
      caller - The id of the user invoking this method
      language - the language code for the language in use by the caller
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getJobs

      java.util.List getJobs​(java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answer the list of all currently executing Jobs, each described by a JobDescriptor. This list will include sub-jobs
      Parameters:
      language - the language code for the language in use by the caller
      caller - The id of the user invoking this method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getPendingEscalators

      java.util.List getPendingEscalators​(java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException, com.ebasetech.ufs.utility.ConcurrentUpdateException
      Answers a list of EscalatorEnactmentDescriptors that list each of the escalators that are currently pending for later firing within the system
      Parameters:
      language - the language code for the language in use by the caller
      caller - The id of the user invoking this method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException
      com.ebasetech.ufs.utility.PersistenceException
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      com.ebasetech.ufs.utility.ConcurrentUpdateException

    • getFilteredPendingEscalators

      java.util.List getFilteredPendingEscalators​(java.lang.String escalatedNodeName, java.lang.String escalatedEnactment, java.lang.String contingentEnactment, java.lang.String jobDescriptor, java.lang.String processName, java.lang.String actorId, java.util.Date dueBefore, java.util.Date dueAfter, boolean waiting, boolean active, boolean completed, boolean cancelled, boolean skipped, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      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. All of the conditions implied by the parameters to this operation are essentially "anded" together.
      Parameters:
      escalatedNodeName - the name of the node which is escalated by the related node of each of the returned escalator enactments. If null then any node may be escalated by the results
      escalatedEnactment - descriptor handle of the nodeEnactment which the returned escalators escalate. If null then the returned escalators may escalate any enactment, subject to the other criteria
      contingentEnactment - descriptor handle of the nodeenactment upon which each returned escalator is contingent, or null if all contingees are required
      jobDescriptor - descriptor handle of a job within which the returned escalators must exist, or null if all jobs are acceptable
      processName - name of the process, jobs for which contain the returned escalators; or null if all processes are acceptable
      actorId - name of the user at whom the resulting escalators are targetted, or null if escalators targetted at any user are acceptable
      dueBefore - the date before which the escalation is due to fire, or null if all are acceptable
      dueAfter - the date after which the escalation is due to fire, or null if all are acceptable
      waiting - if true, all returned escalators are in the waiting state, if false all are returned the finished state of the desired escalator, or null if all are required
      active - if true, all returned escalators are in the active state, if false all are returned the finished state of the desired escalator, or null if all are required
      completed - if true, all returned escalators are in the completed state, if false all are returned the finished state of the desired escalator, or null if all are required
      cancelled - if true, all returned escalators are in the cancelled state, if false all are returned the finished state of the desired escalator, or null if all are required
      skipped - if true, all returned escalators are in the skipped state, if false all are returned the finished state of the desired escalator, or null if all are required
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getTasks

      java.util.List getTasks​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Finds out the extant interactive task enactments for a given job. Answers a list of TaskDescriptors.
      Parameters:
      jobDescriptor - descriptor of the job
      caller - The id of the user invoking this method
      language - the language code for the language in use by the caller
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      getTasks(String, String, String)

    • getTasks

      java.util.List getTasks​(java.lang.String jobDescriptor, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Finds out the extant interactive task enactments for a given job using a stringified descriptor. Answers a list of TaskDescriptors.
      Parameters:
      jobDescriptor - stringified form of the job descriptor
      caller - The id of the user invoking this method
      language - the language code for the language in use by the caller
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      getTasks(com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor, String, String), WorkflowManagement.JobDescriptor.getIdentifier()

    • cancelJob

      void cancelJob​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Cancels a currently executing job
      Parameters:
      jobDescriptor - descriptor of the job to cancel
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      cancelJob(String, String, String)

    • cancelJob

      void cancelJob​(java.lang.String jobDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Cancels a currently executing job
      Parameters:
      jobDescriptor - stringified form of the job descriptor
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      cancelJob(com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor, String, String), WorkflowManagement.JobDescriptor.getIdentifier()

    • complete

      void complete​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String completionState, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Notifies a Job that one of its constituent enactments has been completed with the given completion state. This can only be called with a caller to whom the task is assigned.
      Parameters:
      taskEnactmentDescriptor - descriptor of the enactment that has completed
      completionState - string representation of the completion state of the enactment
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      complete(String, String, String, String)

    • complete

      void complete​(java.lang.String taskEnactmentDescriptor, java.lang.String completionState, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Notifies a Job that one of its constituent enactments has been completed with the given completion state. This can only be called with a caller to whom the task is assigned.
      Parameters:
      taskEnactmentDescriptor - handle to the descriptor of the enactment that has completed
      completionState - string representation of the completion state of the enactment
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      complete(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • complete

      void complete​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String completionState, java.util.Map outParams, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Notifies a Job that one of its constituent enactments has been completed with the given completion state. Defines the output parameters of that completed enactment This can only be called with a caller to whom the task is assigned.
      Parameters:
      taskEnactmentDescriptor - the descriptor of the enactment that has completed
      completionState - string representation of the completion state of the enactment
      outParams - map of the output parameter names and their values
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      complete(String, String, java.util.Map, String, String)

    • complete

      void complete​(java.lang.String taskEnactmentDescriptor, java.lang.String completionState, java.util.Map outParams, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Notifies a Job that one of its constituent enactments has been completed with the given completion state. Defines the output parameters of that completed enactment This can only be called with a caller to whom the task is assigned.
      Parameters:
      taskEnactmentDescriptor - handle to the descriptor of the enactment that has completed
      completionState - string representation of the completion state of the enactment
      outParams - map of the output parameter names and their values
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      complete(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, java.util.Map, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • post

      void post​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String eventId, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Posts a waiting pause node enactment with the corresponding event id. This executes the script associated with the pause node. If this script sets variable $PAUSE_COMPLETION to 'Y', the pause node completes, otherwise the pause node continues to wait. Throws WorkflowManagementException if no pause node enactment exists or if the associated script fails.
      Parameters:
      jobDescriptor - descriptor of the job to cancel
      eventId - the event id of the pause node to be posted
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • post

      void post​(java.lang.String jobDescriptor, java.lang.String eventId, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Posts the pause node enactment with the specified job and event id as complete. Note that any script configured in the pause node is not executed. Throws WorkflowManagementException if no pause node enactment exists.
      Parameters:
      jobDescriptor - stringified form of the job descriptor
      eventId - the event id of the pause node to be posted
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • post

      void post​(java.lang.String process, java.util.Map<java.lang.String,​java.lang.String> processAttributes, java.lang.String eventId, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Posts the pause node enactment with the corresponding event id as complete. The job containing the pause node enactment is identified by the process name and one or more process attribute values. These must uniquely identify a single active job. Note that any script configured in the pause node is not executed. Throws WorkflowManagementException if no pause node enactment exists.
      Parameters:
      process - name of the process
      processAttributes - a map of names and values of process attributes to uniquely identify a single job
      eventId - the event id of the pause node to be posted
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • stateOf

      com.ebasetech.ufs.workflow.server.enactment.state.State stateOf​(WorkflowManagement.FallibleEnactmentDescriptor enactmentDescriptor, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers the state of the described task enactment.
      Parameters:
      enactmentDescriptor - descriptor of the enactment whose state is required
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      stateOf(String, String)

    • stateOf

      com.ebasetech.ufs.workflow.server.enactment.state.State stateOf​(java.lang.String enactmentDescriptor, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers the state of the described task enactment.
      Parameters:
      enactmentDescriptor - handle to the descriptor of the enactment whose state is required
      caller - the id of the caller of the method.
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      stateOf(com.ebasetech.xi.api.workflow.WorkflowManagement.FallibleEnactmentDescriptor, String), WorkflowManagement.FallibleEnactmentDescriptor.getIdentifier()

    • getProcessDescription

      java.lang.String getProcessDescription​(java.lang.String processName, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers the description of the named process.
      Parameters:
      processName - name of the process
      caller - The id of the user invoking this method
      language - the language code for the language in use by the caller
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • activateProcess

      @Deprecated void activateProcess​(java.lang.String processName, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Deprecated.
      From V5.0 this method takes no action and is treated as a no-op
      Throws:
      com.ebasetech.ufs.utility.PersistenceException
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException
      com.ebasetech.ufs.utility.ConcurrentUpdateException
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException

    • quiesceProcess

      @Deprecated void quiesceProcess​(java.lang.String processName, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Deprecated.
      From V5.0 this method takes no action and is treated as a no-op
      Throws:
      com.ebasetech.ufs.utility.PersistenceException
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException
      com.ebasetech.ufs.utility.ConcurrentUpdateException
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException

    • reinstateProcess

      void reinstateProcess​(java.lang.String processName, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Deprecated.
      From V5.0 this method takes no action and is treated as a no-op
      Throws:
      com.ebasetech.ufs.utility.PersistenceException
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException
      com.ebasetech.ufs.utility.ConcurrentUpdateException
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException

    • descriptionOf

      java.lang.String descriptionOf​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers the description of the denoted task enactment
      Parameters:
      taskEnactmentDescriptor - descriptor of the target enactment
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      descriptionOf(String, String, String)

    • descriptionOf

      java.lang.String descriptionOf​(java.lang.String taskEnactmentDescriptor, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers the description of the denoted task enactment
      Parameters:
      taskEnactmentDescriptor - descriptor of the target enactment
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      descriptionOf(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • getCandidateActors

      java.util.Collection getCandidateActors​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers a collection of the possible actor assignments to the identified task enactment
      Parameters:
      taskEnactmentDescriptor - descriptor of the target enactment
      caller - The id of the user invoking this method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      getCandidateActors(String, String)

    • getCandidateActors

      java.util.Collection getCandidateActors​(java.lang.String taskEnactmentDescriptorId, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers a collection of the possible actor assignments to the identified task enactment
      Parameters:
      taskEnactmentDescriptorId - handle to the descriptor of the target enactment
      caller - The id of the user invoking this method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      getCandidateActors(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • setOutputParameter

      void setOutputParameter​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentdescriptor, java.lang.String name, java.lang.Object value, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets a value for the named activity output parameter to be used in subsequent processing.
      Parameters:
      taskEnactmentdescriptor - descriptor of the target enactment
      name - the name of the output parameter
      value - the new value of the output parameter
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setOutputParameter(String, String, Object, String, String)

    • setOutputParameter

      void setOutputParameter​(java.lang.String taskEnactmentdescriptor, java.lang.String name, java.lang.Object value, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets a value for the named activity output parameter to be used in subsequent processing.
      Parameters:
      taskEnactmentdescriptor - descriptor of the target enactment
      name - the name of the output parameter
      value - the new value of the output parameter
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setOutputParameter(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, String, Object, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • setOutputParameters

      void setOutputParameters​(java.lang.String taskEnactmentDescriptor, java.util.Map outParams, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets the values for the named activity output parameters to be used in subsequent processing. The parameter names are the names from the activity. The mappings set at design-time between the activity out params and the job's process attributes will be used to store the parameter values on the job.
      Parameters:
      taskEnactmentDescriptor - stringified form of the descriptor of the target enactment
      outParams - map of the output parameters names and values
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setOutputParameters(com.ebasetech.xi.api.workflow.WorkflowManagement.InteractiveTaskEnactmentDescriptor, java.util.Map, String, String), WorkflowManagement.InteractiveTaskEnactmentDescriptor.getIdentifier()

    • setOutputParameters

      void setOutputParameters​(WorkflowManagement.InteractiveTaskEnactmentDescriptor taskEnactmentDescriptor, java.util.Map outParams, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets the values for the named activity output parameters to be used in subsequent processing. The parameter names are the names from the activity. The mappings set at design-time between the activity out params and the job's process attributes will be used to store the parameter values on the job.
      Parameters:
      taskEnactmentDescriptor - the descriptor of the target enactment
      outParams - map of the output parameters names and values
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setOutputParameters(String, java.util.Map, String, String)

    • getProcessAttributeValue

      java.lang.Object getProcessAttributeValue​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String name, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Gets the value for the named process attribute in the context of the defined job
      Parameters:
      jobDescriptor - descriptor of the target job
      name - name of the desired attribute
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      getProcessAttributeValue(String, String, String)

    • getProcessAttributeValue

      java.lang.Object getProcessAttributeValue​(java.lang.String jobDescriptor, java.lang.String name, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Gets the value for the named process attribute.
      Parameters:
      jobDescriptor - handle to the descriptor of the target job
      name - name of the desired attribute
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      getProcessAttributeValue(com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor, String, String), WorkflowManagement.JobDescriptor.getIdentifier()

    • getProcessAttributeValues

      java.util.Map getProcessAttributeValues​(java.lang.String jobDescriptor, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Answers a map of process attribute names agains their current runtime values.
      Parameters:
      jobDescriptor - descriptor of the target job
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.utility.PersistenceException
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      getProcessAttributeValue(com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor, String, String), WorkflowManagement.JobDescriptor.getIdentifier()

    • setProcessAttributeValue

      void setProcessAttributeValue​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String name, java.lang.Object value, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets the value for the named process attribute.
      Parameters:
      jobDescriptor - descriptor of the target job
      name - name of the desired attribute
      value - new value for the named attibute
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setProcessAttributeValue(String, String, Object, String, String)

    • setProcessAttributeValue

      void setProcessAttributeValue​(java.lang.String jobDescriptor, java.lang.String name, java.lang.Object value, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Sets the value for the named process attribute.
      Parameters:
      jobDescriptor - handle to the descriptor of the target job
      name - name of the desired attribute
      value - new value for the named attibute
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility
      See Also:
      setProcessAttributeValue(com.ebasetech.xi.api.workflow.WorkflowManagement.JobDescriptor, String, Object, String, String), WorkflowManagement.JobDescriptor.getIdentifier()

    • setJobOwner

      void setJobOwner​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String actorId, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Assign a particular owner to the denoted job
      Parameters:
      jobDescriptor - The assignable object that is to be updated
      actorId - The name of the actor to assign to the enactment
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • unsetJobOwner

      void unsetJobOwner​(WorkflowManagement.JobDescriptor jobDescriptor, java.lang.String reason, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      Clears the owner for the denoted job.
      Parameters:
      jobDescriptor - The assignable object that is to be updated
      reason - a textual reason for invoking this method
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getJobsForOwner

      java.util.List getJobsForOwner​(java.lang.String owner, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      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
      Parameters:
      owner - named owner of the result jobs or null if all jobs are required
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility

    • getFilteredJobs

      java.util.List getFilteredJobs​(java.lang.String jobId, java.lang.String process, java.lang.String opener, java.lang.String owner, java.lang.Boolean finished, java.util.Date creationDateFrom, java.util.Date creationDateTo, java.util.Date modifiedDateFrom, java.util.Date modifiedDateTo, java.util.Map<java.lang.String,​java.lang.String> processAttributes, boolean ignoreSubJobs, boolean includeStepMode, java.lang.String language, java.lang.String caller) throws com.ebasetech.ufs.utility.PersistenceException, com.ebasetech.ufs.workflow.server.external.WorkflowManagementException, com.ebasetech.ufs.utility.ConcurrentUpdateException, com.ebasetech.ufs.workflow.security.WorkflowSecurityException
      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
      Parameters:
      jobId - descriptor handle of the required job, of null if all jobs are required
      process - name of the process for which result jobs are required, or null if jobs on all processes are required
      opener - name of the opener of the desired jobs, or null if all openers are acceptable
      owner - name of the owner of the desired jobs, or null if all owners are acceptable
      finished - the finished state of the desired jobs, or null if all are required
      creationDateFrom - when creationDateTo is not null, specifies the lower creation date range value for returned jobs
      creationDateTo - when creationDateFrom is not null, specifies the upper creation date range value for returned jobs
      modifiedDateFrom - when modifiedDateTo is not null, specifies the lower last modified date range value for returned jobs
      modifiedDateTo - when modifiedDateFrom is not null, specifies the upper last modified date range value for returned jobs
      processAttributes - a map of names and values of process attributes to filter the job by
      ignoreSubJobs - whether sub-jobs should be included in the results list
      includeStepMode -
      language - the language code for the language in use by the caller
      caller - the id of the caller of the method
      Throws:
      com.ebasetech.ufs.workflow.server.external.WorkflowManagementException - if there is some problem with invoking the operation on the underlying objects. This could be, for example, a request to transition the state in a disallowed manner.
      com.ebasetech.ufs.utility.PersistenceException - if there is a problem with the underlying persistence framework such as not being able to find the requested object
      com.ebasetech.ufs.utility.ConcurrentUpdateException - if accessing the underlying database tables causes a conflict with some other processer in the cluster
      com.ebasetech.ufs.workflow.security.WorkflowSecurityException - if the supplied caller is not allowed to access this facility