Package com.groiss.wf

Interface RemoteWfEngine

All Superinterfaces:
Remote
All Known Subinterfaces:
WfEngine
@Deprecated(since="11.0", forRemoval=true) public interface RemoteWfEngine extends Remote
Deprecated, for removal: This API element is subject to removal in a future version.
This interface encapsulates the functionality of the @enterprise workflow engine. An object implementing this interface can be created on the server or the client.

Most methods have an implicit user parameter. This is initialized as the ThreadPrincipal from the ThreadContext when the WfEngine object is created.

  • Field Details

  • Method Details

    • getStore

      @Deprecated(since="11.0", forRemoval=true) RemoteStore getStore() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      use Store.getInstance() instead
      Return the underlying store.
      Returns:
      a store object
      Throws:
      RemoteException

    • getProcessDefinition

      ProcessDefinition getProcessDefinition(String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find a process definition with the given id and status=active, if more than one is found, the process definition with the highest version number is returned.
      Parameters:
      id - the id of the process
      Returns:
      a process definition
      Throws:
      RemoteException

    • getProcessDefinition

      ProcessDefinition getProcessDefinition(String id, int version) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find a process definition with the given id and version.
      Parameters:
      id - the id of the process
      version - the version of the process
      Returns:
      a process definition
      Throws:
      RemoteException

    • listProcessDefinitions

      List<ProcessDefinition> listProcessDefinitions(Application appl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      List the process definitions of the given application
      Parameters:
      appl - the application
      Returns:
      a list of ProcessDefinition objects
      Throws:
      RemoteException

    • getStartableProcesses

      @Deprecated List<Pair<ProcessDefinition,List<OrgUnit>>> getStartableProcesses(Application appl) throws RemoteException
      Deprecated.
      use getStartableProcDefs
      List the process definitions of the given application, which are startable for the user. A process is startable, if it is active and the agent of the first step is either the user or a role the user has.
      Returns:
      the list of pairs of processes and lists of OrgUnits
      Throws:
      RemoteException

    • getStartableProcDefs

      List<Pair<ProcessDefinition,List<Pair<String,List<OrgUnit>>>>> getStartableProcDefs(Application appl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      List the process definitions of the given application, which are startable for the user. A process is startable, if it is active and the agent of a start task is either the user or a role the user has. A start task is a task where between the task and the begin node is no interactive task.
      Parameters:
      appl - optional application restriction
      Returns:
      a list of pairs of processes and lists of pairs of step-labels and lists of org-units
      Throws:
      RemoteException

    • getStartInfo

      List<Pair<String,List<OrgUnit>>> getStartInfo(ProcessDefinition pd) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the start info for the given process for the current thread user. If this user cannot start the process, the result is empty.
      Parameters:
      pd - a process definition
      Returns:
      the list of pairs of step-labels and lists of OrgUnits
      Throws:
      RemoteException

    • getTask

      Task getTask(String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find a task with the given id and status=active, if more than one is found, the task with the highest version number is returned.
      Parameters:
      id - the id of the task
      Returns:
      a task, null if no task has the given id
      Throws:
      RemoteException

    • getTask

      Task getTask(String id, int version) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find a task with the given id and version.
      Parameters:
      id - the id of the task
      version - the version of the task
      Returns:
      a task
      Throws:
      RemoteException

    • startProcess

      ProcessInstance startProcess(ProcessDefinition p, User u, OrgUnit d, Date duedate, String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Start a process. ProcessDefinition and OrgUnit must not be null.
      Parameters:
      p - the process definition
      u - the user
      d - the org. unit
      duedate - the duedate
      id - the id of the process instance
      Returns:
      the process instance
      Throws:
      RemoteException

    • startProcess

      ProcessInstance startProcess(ProcessDefinition p, User u, OrgUnit d, Date duedate, String id, DMSForm f) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Start a process. ProcessDefinition and OrgUnit must not be null. The form must be already in the database.
      Parameters:
      p - the process definition
      u - the user
      d - the org. unit
      duedate - the duedate
      id - the id of the process instance
      f - a form
      Returns:
      the process instance
      Throws:
      RemoteException

    • createProcessInstance

      ProcessInstance createProcessInstance(ProcessDefinition p, User u, OrgUnit d, Date duedate, String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a process instance. ProcessDefinition and OrgUnit must not be null. The process instance waits at the begin step until this activityinstance will be finished explicitely, or until start(pi) is called.
      Parameters:
      p - the process definition
      u - the user
      d - the org. unit
      duedate - the duedate
      id - the id of the process instance
      Returns:
      the process instance
      Throws:
      RemoteException

    • createProcessInstance

      ProcessInstance createProcessInstance(ProcessDefinition p, User u, OrgUnit d, Date duedate, String id, DMSForm f) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a process instance. ProcessDefinition and OrgUnit must not be null. The process instance waits at the begin step until this activityinstance will be finished explicitely, or until start(pi) is called.
      Parameters:
      p - the process definition
      u - the user
      d - the org. unit
      duedate - the duedate
      id - the id of the process instance
      f - a form
      Returns:
      the process instance
      Throws:
      RemoteException

    • start

      void start(ProcessInstance pi) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Start a process instance, which was previously created, but not started.
      Parameters:
      pi - the process instance to start
      Throws:
      RemoteException

    • getWorklist

      List<ActivityInstance> getWorklist(Application a, boolean withRepr) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the worklist of the current user.
      Parameters:
      a - the application, if null return work items for all applications
      withRepr - if true add the work items assigned to persons the user substitutes.
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getWaitingList

      List<ActivityInstance> getWaitingList(Application a) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of waiting activities of the current user.
      Parameters:
      a - the application, if null return waiting items for all applications
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getRoleWorklist

      List<ActivityInstance> getRoleWorklist(Application a) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the role worklist of the current user.
      Parameters:
      a - the application, if null return work items for all applications
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getSuspensionList

      List<ActivityInstance> getSuspensionList(Application a) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the personal suspension list of the current user.
      Parameters:
      a - the application, if null return work items for all applications
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getRoleSuspensionList

      List<ActivityInstance> getRoleSuspensionList(Application a) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the role suspension list of the current user.
      Parameters:
      a - the application, if null return work items for all applications
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getWorklist

      List<ActivityInstance> getWorklist(WorklistKind wlKind, Application a) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get a worklist of the desired kind for the current user.
      Parameters:
      wlKind - the kind of worklist to be returned
      a - the application, if null return work items for all applications
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getWorklist

      List<ActivityInstance> getWorklist(Set<WorklistKind> wlKinds, Application a) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get a combined worklist of the combination (union) of the desired kinds for the current user.
      Parameters:
      wlKinds - the kinds of worklists to be returned
      a - the application, if null return work items for all applications
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • isVisible

      boolean isVisible(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Determines whether an ActivityInstance is visible for the current user. It is visible when one of the worklists of the current user contains the ai.
      Parameters:
      ai -
      Returns:
      true, if the passed ActivityInstance is in one of the worklists of the user (personal, role, suspension, rolesuspension, pending, or via representation)
      Throws:
      RemoteException

    • getProcess

      ProcessInstance getProcess(String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find a process instance with the given id. If more than one process instances qualify, then ApplicationException(1125) will be thrown.
      Parameters:
      id - the process instance id
      Returns:
      the process instance
      Throws:
      RemoteException

    • getProcess

      ProcessInstance getProcess(long oid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find a process instance from the given oid.
      Parameters:
      oid - the process instance oid
      Returns:
      the process instance
      Throws:
      RemoteException

    • getProcessFromForm

      ProcessInstance getProcessFromForm(long formoid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find a process instance from the oid of a form.
      Parameters:
      formoid - the oid of a process form
      Returns:
      the process instance
      Throws:
      RemoteException

    • getActivityInstance

      ActivityInstance getActivityInstance(long oid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find a activity instance from the given oid.
      Parameters:
      oid - the activity instance oid
      Returns:
      the process instance
      Throws:
      RemoteException

    • getProcess

      ProcessInstance getProcess(DMSForm f) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find the process instance where the given form is attached. The method returns a process if and only if the form is a process form. It returns null for subforms. It always returns the "latest" process-instance (latest started, highest oid). This is important, if a form is attached to more than one process instance, for example a parfor in an iteration.
      Parameters:
      f - the form
      Returns:
      the process instance
      Throws:
      RemoteException

    • getProcesses

      List<ProcessInstance> getProcesses(String condition) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find the process instances with a given condition.
      Parameters:
      condition - a SQL where clause
      Returns:
      a list of process instances
      Throws:
      RemoteException

    • getActivities

      List<ActivityInstance> getActivities(String condition) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find the activity instances with a given condition.
      Parameters:
      condition - a SQL where clause
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getAllCurrentActivityInstances

      List<ActivityInstance> getAllCurrentActivityInstances(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of ALL active activities of a process instance. ATTENTION: this method returns all tasks with Type =ActivityInstance.TASK), as well as all longrunning activity instances [Type in (ActivityInstance.SYSTEM_WAIT, ActivityInstance.BATCH, ActivityInstance.WS_INVOKE, ActivityInstance.WS_RECEIVE, ActivityInstance.WAIT)] ActivityInstances of the given ProcessInstance, even ALL children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will be returned
      Parameters:
      process - the process instance
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getAllInteractiveTasks

      List<ActivityInstance> getAllInteractiveTasks(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of ALL active, interactive activities of a process instance. ATTENTION: this method returns all interactive (Type =ActivityInstance.TASK) ActivityInstances of the given ProcessInstance, even ALL children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will be returned
      Parameters:
      process - the process instance
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getActiveTasks

      List<ActivityInstance> getActiveTasks(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of active activities of a process instance. ATTENTION: this method returns all types of ActivityInstance, but doesn't return ALL ActivityInstances of the given ProcessInstance. children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will not be returned
      Parameters:
      process - the process instance
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getActiveTasks

      List<ActivityInstance> getActiveTasks(ProcessInstance process, User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of active, interactive activities of a process instance assigned to a user. ATTENTION: this method returns only interactive (Type =ActivityInstance.TASK) ActivityInstances of the given ProcessInstance, but doesn't return ALL interactive ActivityInstances of the given ProcessInstance. children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will not be returned
      Parameters:
      u - the user
      process - the process instance
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getActivityInstances

      List<ActivityInstance> getActivityInstances(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of all direct activity instances of a process instance.

      ATTENTION: this method doesn't return ALL ActivityInstances of the given ProcessInstance. children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will not be returned
      Parameters:
      process - the process instance
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getActivityInstances

      List<ActivityInstance> getActivityInstances(ProcessInstance process, String stepid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of direct activity instances of a particular step in a process.

      ATTENTION: this method doesn't return ALL ActivityInstances of the given ProcessInstance. children of ActivityInstance.PROCESS, ActivityInstance.PARFOR and ActivityInstance.SCOPE will not be returned
      Parameters:
      process - the process instance
      stepid - the id of the step
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • getActivityInstances

      List<ActivityInstance> getActivityInstances(ProcessInstance process, boolean recursive, boolean active, int type, String stepid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get a list of activity instances for a process instance
      Parameters:
      process - the process instance
      recursive - if true, also nested activity instances will be returned
      active - if true, only active activity instances will be returned
      type - of activity instances to return, if all types should be returned, use ActivityInstance.ALL
      stepid - restrict the results by id of the step, use null if no restriction intended
      Returns:
      Throws:
      RemoteException

    • getDocuments

      List<DMSObject> getDocuments(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of DMS objects (e.g. documents, folders) attached to a process.
      Parameters:
      process - the process instance
      Returns:
      a list of DMSObject
      Throws:
      RemoteException

    • getForm

      <P extends DMSForm> P getForm(ActivityInstance ai, String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get a form of a process.
      Parameters:
      ai - the process instance or an activity instance of the process
      id - the id of the form in the process
      Returns:
      the form
      Throws:
      RemoteException

    • hasForm

      boolean hasForm(ActivityInstance ai, String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check if the process has a form with given id.
      Parameters:
      ai - the process instance or an activity instance of the process
      id - the id of the form in the process
      Returns:
      true if the form exists
      Throws:
      RemoteException

    • getForms

      List<DMSForm> getForms(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the forms of a process.
      Parameters:
      process - the process instance
      Returns:
      the forms (DMSForm objects)
      Throws:
      RemoteException

    • getMainProcess

      ProcessInstance getMainProcess(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the root of the activity instance tree
      Parameters:
      ai - an activity instance
      Returns:
      the process instance of the main process of the given activity instance.
      Throws:
      RemoteException

    • getParent

      ProcessInstance getParent(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the process instance of the given activity instance.
      Parameters:
      ai - an activity instance
      Returns:
      the process instance
      Throws:
      RemoteException

    • getNotes

      List<DMSNote> getNotes(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the notes to a process instances
      Parameters:
      process - a process instance
      Returns:
      a list of notes (DMSNote objects)
      Throws:
      RemoteException

    • hasDocuments

      boolean hasDocuments(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Has the process documents attached?
      Parameters:
      process - a process instance
      Returns:
      true if documents are present
      Throws:
      RemoteException

    • hasNotes

      boolean hasNotes(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Has the process notes attached?
      Parameters:
      process - a process instance
      Returns:
      true if notes are present
      Throws:
      RemoteException

    • getFieldModes

      Map<String,Short> getFieldModes(ActivityInstance ai, DMSForm f) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get field modes for form fields
      Parameters:
      ai - an activity instance
      f - the form
      Returns:
      A map where the keys are the attribute names, the values are INVISIBLE, READ_ONLY, READ_WRITE, TEXT, MUST, NO_ADDDEL as short objects
      Throws:
      RemoteException

    • getFieldModes

      Map<String,Short> getFieldModes(ActivityInstance ai, DMSForm form, DMSForm mainform, String id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get field modes for form fields and subforms
      Parameters:
      ai - activity instance
      form - form or sub form, may be null if mainform is set
      mainform - main form, may be null if form is already contain mainform
      id - subform relation id
      Returns:
      see getFieldModes(ActivityInstance, DMSForm)
      Throws:
      RemoteException

    • getSuspensions

      List<Suspension> getSuspensions(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find out when and how the activity instance was in the suspension list.
      Parameters:
      ai -
      Returns:
      a list of Suspensions
      Throws:
      RemoteException

    • canTake

      void canTake(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check if the thread-user can take the activity.
      Parameters:
      ai - an activity instance
      Throws:
      RemoteException

    • take

      ActivityInstance take(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Take an activity: move it from the role-worklist to the worklist.
      Parameters:
      ai - an activity instance that is created after the take operation;
      ThreadContext.getAttribute("untakenActivity") returns the activity instance which has been created before the take operation
      Returns:
      the activity instance now active, this may be the same as the parameter but can also be another object
      Throws:
      RemoteException

    • finish

      void finish(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finsh an activity, the engine starts the next step.
      Parameters:
      ai - an activity instance
      Throws:
      RemoteException

    • getChoiceSteps

      List<List<ActivityInstance>> getChoiceSteps(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use this method to get the possible choice branches when the process execution reaches a choice. The method returns a list of lists, each inner list contains the choice branches belonging to one choice.
      Parameters:
      ai -
      Returns:
      a list of lists of ActivityInstances
      Throws:
      RemoteException

    • finishChoice

      void finishChoice(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finishs a choice branch, abort the other branches.
      Parameters:
      ai - the choice step on the branch you want to follows
      Throws:
      RemoteException

    • closePredecessor

      void closePredecessor(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      If the predecessor of ai was not finished completely (is in status WAITING) and the necessary action is done now (for example setting the agent for ai) this method will complete it. If the predecessor is in another state it does nothing.
      Parameters:
      ai -
      Throws:
      RemoteException

    • listPreviousSteps

      List<Pair<ActivityInstance,List<ActivityInstance>>> listPreviousSteps(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      List the previous steps of the process (possible go back targets).
      Parameters:
      ai - current activity instance
      Returns:
      a list of Pairs. The first element of the pair is a previous activity instance, the second is a list of activities that must be aborted when going back to this step (for example siblings in a parallelism).
      Throws:
      RemoteException

    • goBack

      ActivityInstance goBack(ActivityInstance ai, ActivityInstance ai2, String comment) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Go back to a previous step. A clone of the given previous activity instance of this process instance is created, the comment is added to the new activity.
      Parameters:
      ai - an activity instance
      ai2 - a finished activity instance
      comment - a comment
      Returns:
      the activity instance now active
      Throws:
      RemoteException

    • untake

      ActivityInstance untake(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Put back an activity: move it from the worklist to the role-worklist.
      Parameters:
      ai - an activity instance that is created before the untake operation;
      ThreadContext.getAttribute("untakenActivity") returns the activity instance which has been created after the take operation
      Returns:
      the activity instance now active
      Throws:
      RemoteException

    • seeLater

      void seeLater(ActivityInstance ai, Date d) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Move the activity instance from the worklist to the suspension list.
      Parameters:
      ai - an activity instance
      d - the date, when the item should reappear in the worklist
      Throws:
      RemoteException

    • seeLater

      void seeLater(ActivityInstance ai, Date d, String description) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Move the activity instance from the worklist to the suspension list.
      Parameters:
      ai - an activity instance
      d - the date, when the item should reappear in the worklist
      description - an optional comment
      Throws:
      RemoteException

    • seeAgain

      void seeAgain(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Move the activity instance from the suspension list to the worklist.
      Parameters:
      ai - an activity instance
      Throws:
      RemoteException

    • setAgent

      void setAgent(ActivityInstance ai, Agent a) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Give the activity instance to another agent. Please note that this method does not set the step agent (which is needed e.g. for untake operation)!
      Parameters:
      ai - an activity instance
      a - an agent (user or role)
      Throws:
      RemoteException

    • changeAgent

      ActivityInstance changeAgent(ActivityInstance ai, Agent a, OrgUnit ou, String comment) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Give the activity instance to another agent. Change is visible in process history
      Parameters:
      ai - an activity instance
      a - an agent (user or role)
      ou - an org-unit, may be null
      comment - optional comment to the next agent
      Throws:
      RemoteException

    • setStepAgent

      void setStepAgent(ActivityInstance ai, Agent a) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the step-agent of the activity instance to another agent. This is the agent where a untake of the activity instance
      Parameters:
      ai - an activity instance
      a - an agent (user or role)
      Throws:
      RemoteException

    • gotoTask

      @Deprecated void gotoTask(ProcessInstance process, String taskid, Agent ag, String comment) throws RemoteException
      Deprecated.
      the method behaves unpredictabe when more than one activity instance of the process is active and when the task appears more than once in the process definition. use gotoStep
      Goto another task. The process flow leaves the defined route and jumps to the given task. The id of the task, an agent and a comment is given.
      Parameters:
      process - an processinstance instance
      taskid - id of a task
      ag - an agent (user or role)
      comment - a comment string
      Throws:
      RemoteException

    • gotoTask

      @Deprecated void gotoTask(ActivityInstance ai, String stepname, Agent ag, OrgUnit ou, String comment) throws RemoteException
      Deprecated.
      use gotoStep
      Goto another task. The process flow leaves the defined route and jumps to the given task. Preprocessing is executed.
      Parameters:
      ai - an activity instance
      stepname - the name of a step to jump to, set the name in the process definition (editor or WDL).
      ag - an agent (user or role), may be null
      ou - the org.unit (may be null)
      comment - a comment string
      Throws:
      RemoteException

    • gotoStep

      ActivityInstance gotoStep(ActivityInstance ai, String stepid, Agent ag, OrgUnit ou, String comment) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Goto another step. The process flow leaves the defined route and jumps to the given step. Preprocessing is executed if step is a task.
      Parameters:
      ai - an activity instance
      stepid - the id of a step to jump to, set the id in the process definition (editor or WDL).
      ag - an agent (user or role), may be null. Will be ignored if the specified step is not a task
      ou - the org.unit (may be null). Will be ignored if the specified step is not a task
      comment - a comment string
      Returns:
      the ActivityInstance of the target step (defined by stepid)
      Throws:
      RemoteException

    • copyTo

      ActivityInstance copyTo(ActivityInstance ai, User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Send a copy to another user.
      Parameters:
      ai - an activity instance
      u - a user
      Returns:
      the copy activity instance
      Throws:
      RemoteException

    • copyTo

      ActivityInstance copyTo(ActivityInstance ai, User u, String comment) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Send a copy to another user.
      Parameters:
      ai - an activity instance
      u - a user
      comment - a comment to this copy
      Returns:
      the copy activity instance
      Throws:
      RemoteException

    • makeBranch

      @Deprecated void makeBranch(ProcessInstance process, Task t, Agent a, OrgUnit d, List<String> forms) throws RemoteException
      Deprecated.
      use method without form argument
      Insert a new step - subprocess or task - to the running process. The step is added as a branch and can be completed independent of the process.
      Throws:
      RemoteException

    • makeBranch

      ActivityInstance makeBranch(ProcessInstance process, Task t, Agent a, OrgUnit d) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Insert a new step to the running process. The step is added as a branch and can be completed independent of the process.
      Parameters:
      process - instance of the process
      t - a task assigned to the process
      a - a user or role
      d - an optional department
      Throws:
      RemoteException

    • startBranch

      void startBranch(ProcessInstance process, String branchid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Start a branch. In a process where a branch is defined, this call start the branch. This can be done independent of the normal process flow.
      Parameters:
      process - process instance
      branchid - the step-id of the branch step.
      Throws:
      RemoteException

    • addParforInstances

      int addParforInstances(String stepid, ActivityInstance previous) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Start additional parfor branches for the given step. Branches are only started if there are already running branches.
      Parameters:
      stepid - the id of the parfor step
      previous - an activity instance of the same process instance
      Throws:
      RemoteException

    • setOrgUnit

      void setOrgUnit(ActivityInstance ai, OrgUnit d) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Change the organizational unit of a process.
      Parameters:
      ai - an activity instance
      d - the OrgUnit
      Throws:
      RemoteException

    • setDescription

      void setDescription(ActivityInstance ai, String descr) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the description of an activity instance.
      Parameters:
      ai - an activity instance
      descr - the new desription
      Throws:
      RemoteException

    • setSubject

      void setSubject(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the subject of the process instance according to the definition in the process definition.
      Parameters:
      process - the process instance
      Throws:
      RemoteException

    • setSubjectToString

      void setSubjectToString(ProcessInstance process, String str) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the subject of the process instance o the given string value.
      Parameters:
      process - the process instance
      str - the new subject
      Throws:
      RemoteException

    • updateForm

      void updateForm(DMSForm f) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Update the form (make the changes persistent).
      Parameters:
      f - the form
      Throws:
      RemoteException

    • setDuedate

      void setDuedate(ActivityInstance ai, Date d) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the duedate of the activity instance.
      Parameters:
      ai - an activity instance
      d - the new due date
      Throws:
      RemoteException

    • setId

      void setId(ProcessInstance pi, String s) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the id of the process instance.
      Parameters:
      pi - a process instance
      s - the new id
      Throws:
      RemoteException

    • setPriority

      void setPriority(ProcessInstance pi, int priority) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the priority of the process instance.
      Parameters:
      pi - a process instance. The priority is set on the main process instance mpi of pi (and on subprocesses of mpi).
      priority - the new priority, two digit integer, starting with 0 (means lowest priority).
      Throws:
      RemoteException

    • abort

      void abort(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Abort a process.
      Parameters:
      process - the process instance. Should be a main Process, may be an ActivityInstance in a branch.
      Throws:
      RemoteException

    • reactivate

      void reactivate(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reactivate a process.
      Parameters:
      process - the process instance. Should be a main process.
      Throws:
      RemoteException

    • archive

      void archive(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Archive a process. Remove it from the database.
      Parameters:
      process - the process instance
      Throws:
      RemoteException

    • checkAbort

      void checkAbort(ProcessInstance process) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check if the thread user may abort the process. Either start agent and process in first step or edit process instance right.
      Throws:
      RemoteException

    • abort

      void abort(ProcessInstance process, String comment) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Abort a process and add a DMSNote with a generated Subject and a given comment.
      Parameters:
      process - the process instance. Should be a main Process, may be an ActivityInstance in a branch.
      comment - a comment, why the process is aborted
      Throws:
      RemoteException

    • reactivate

      void reactivate(ProcessInstance process, String comment) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reactivate a process.
      Parameters:
      process - the process instance. Should be a main Process.
      comment - a comment, why the process is reactivated
      Throws:
      RemoteException

    • reactivateAndTake

      void reactivateAndTake(ProcessInstance process, String comment) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reactivate a process and take the reactivated tasks.
      Parameters:
      process - the process instance. Should be a main Process.
      comment - a comment, why the process is reactivated
      Throws:
      RemoteException

    • getContext

      ActivityInstance getContext() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the current activity instance. This method returns a non-null value when called from a postcondition, preprocessing, compensation method of a task of from a system step or a condition in a process definition.
      Returns:
      an activity instance
      Throws:
      RemoteException

    • setContext

      void setContext(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      RemoteException

    • getServerProperty

      String getServerProperty(String prop) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a property from the server
      Returns:
      the property, null if the property is unknown.
      Throws:
      RemoteException

    • listSuccessors

      List<ActivityInstance> listSuccessors(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the list of successor steps of an activity instance.
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • listPredecessors

      List<ActivityInstance> listPredecessors(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the list of predecessor steps of an activity instance.
      Returns:
      a list of activity instances
      Throws:
      RemoteException

    • addAgent

      void addAgent(ActivityInstance ai, Agent a, OrgUnit ou, DMSNote note) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add an agent which receives the process after the current agent
      Parameters:
      ai - the activity instance
      a - a user or role
      ou - an organizational unit, if null the ou of the previous activity instance is used
      note - an (optional) note to the agent of the activity
      Throws:
      RemoteException

    • getLastInteractive

      ActivityInstance getLastInteractive(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the last interactive activityinstance (type=TASK).
      Parameters:
      ai - the activity instance to start from (backwards)
      Returns:
      the last TASK executed in the flow before ai, or null
      Throws:
      RemoteException

    • goBackToLastInteractive

      void goBackToLastInteractive(ActivityInstance ai, String comment) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Go back to the last interactive activity instance.
      Parameters:
      ai - the activity instance to start from (backwards)
      comment - a comment to store in the process history (e.g. the reason for going back)
      Throws:
      RemoteException

    • makeVersion

      ActivityInstance makeVersion(ActivityInstance ai, String desc, boolean withDocs) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Versions the passed activity instance, the process forms and the documents (optional) and returns a new activity instance which is a copy of the passed one.
      Parameters:
      ai - the activity instance to version
      desc - a comment for this version
      withDocs - if true all the documents are also versioned
      Returns:
      the new activity instance
      Throws:
      RemoteException

    • refreshWLCacheOrgData

      void refreshWLCacheOrgData() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Refresh the organizational data in the worklist cache.
      Throws:
      RemoteException

    • refreshWLCache

      void refreshWLCache(User u) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Refresh the organizational data in the WorklistCache for a particular user.
      Parameters:
      u - - the user
      Throws:
      RemoteException

    • setFinished

      void setFinished(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the status of the activity instance to FINISHED. This method should be used only in the expressions in an andjoin or end parfor node. In case of parfor set the state of the parent of the current activity instance. In both cases if you set the state to finished the engine will continue the process after the parallelism.
      Parameters:
      ai - the activity instance to be finished
      Throws:
      RemoteException

    • abortSiblings

      void abortSiblings(ActivityInstance join) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Abort the siblings of the par branch. The activity instance must be an instance of the andjoin node. Note that you must assure that the process continues after the andjoin, you can do this by calling wfEngine.setFinished(join) - otherwise the process will hang in the andjoin
      Parameters:
      join -
      Throws:
      RemoteException

    • abortParforSiblings

      void abortParforSiblings(ActivityInstance parfor) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Abort the running siblings of the current parfor instances. Note that you must assure that the process continues after the parfor, you can do this by calling wfEngine.setFinished(parfor) - otherwise the process will hang in the end parfor node
      Parameters:
      parfor - an instance of the parfor step (a parent of an activityinstance inside the parfor)
      Throws:
      RemoteException

    • setSeen

      void setSeen(ActivityInstance ai, boolean seen) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the given ActivityInstance to seen/unseen for the current user.
      Throws:
      RemoteException

    • removeSeens

      void removeSeens(ActivityInstance ai, boolean meToo) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Delete the seen information for the given ai.
      Parameters:
      ai - an activity instance
      meToo - if true the seen information for the current user is also deleted.
      Throws:
      RemoteException

    • hasSeen

      boolean hasSeen(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns true if the ActivityInstance has been seen by the current user.
      Throws:
      RemoteException

    • getFormVersion

      PersistentVersion getFormVersion(DMSForm form, ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the version of the passed form in the context of the passed activity instance.
      Parameters:
      form - the form which version is wanted
      ai - the activity instance determining the context of the version
      Returns:
      the requested version or null if there is no such version
      Throws:
      RemoteException

    • listFormVersions

      List<PersistentVersion> listFormVersions(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of form versions (at most one for each process form) which were made in the context of the passed activity instance.
      Parameters:
      ai - the activity instance determining the context of the versions
      Returns:
      the requested versions or an empty list if there are no such versions
      Throws:
      RemoteException

    • addSystemNote

      void addSystemNote(ActivityInstance ai, String subject, String text) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attach a note to an ActivityInstance.
      Parameters:
      ai - the activity instance (or process instance) to which the note is attached
      subject - the system note subject
      text - the system note text
      Throws:
      RemoteException - Exception is thrown if the system note could not be created or attached to the given activity instance

    • propagateChange

      void propagateChange(ActivityInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Inform the system that a change to an ActivityInstance has been made. Notifications will be sent to the clients.

      This is only needed in special cases, when there were changes in some data that would lead to a different presentation of the ActivityInstance in a client and which where out of the scope of the automatic worklist change detection (e.g. redisplay a worklist item after some form update).

      Parameters:
      ai - the activity instance which has changed
      Throws:
      RemoteException

    • propagateProcessChange

      void propagateProcessChange(ProcessInstance pi) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Inform the system that a process instance has been changed. Notifications for all active tasks directly below this process instance will be sent to the clients.

      This is only needed in special cases, when there were changes in some data that would lead to different presentations in the worklists and which where out of the scope of the automatic worklist change detection (e.g. changes in displayed additional data).

      Parameters:
      pi - the process instance which has changed
      Throws:
      RemoteException

    • propagateProcessChangeRecursive

      void propagateProcessChangeRecursive(ProcessInstance pi)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Inform the system that a process instance has been changed. Notifications for all active tasks below this process instance will be sent to the clients. Recurses into parfor substructures but not into subprocesses.

      This is only needed in special cases, when there were changes in some data that would lead to different presentations in the worklists and which where out of the scope of the automatic worklist change detection (e.g. changes in displayed additional data).

      Parameters:
      pi - the process instance which has changed

    • getUserFolders

      List<UserFolder> getUserFolders() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the list of UserFolders of the current user.
      Returns:
      the list of UserFolders of the current user.
      Throws:
      RemoteException

    • mapToUserFolders

      Map<ActivityInstance,UserFolder> mapToUserFolders(List<ActivityInstance> ais) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Map a list of ActivityInstances to their corresponding UserFolders. If an ActivityInstance is in no UserFolder at all, it is not contained in the map.
      Parameters:
      ais - the list of activityInstances to be filtered
      Returns:
      the map of ActivityInstances to UserFolders
      Throws:
      RemoteException

    • filterByFolder

      void filterByFolder(UserFolder uf, List<ActivityInstance> ais) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Filter a list of ActivityInstances. Keep those that are in the specified UserFolder. If the UserFolder is null, then all those ActivityInstances are kept in the list, that are in no UserFolder at all.
      Parameters:
      uf - the UserFolder to filter upon.
      ais - the list of ActivityInstances to be filtered
      Throws:
      RemoteException

    • hasMark

      boolean hasMark(ProcessInstance ai) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns true if the ProcessInstance has been marked by the current user.
      Throws:
      RemoteException

    • setMark

      void setMark(ProcessInstance pi, boolean mark) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the given ProcessInstance to marked/unmarked for the current user.
      Throws:
      RemoteException