Package wt.workflow.work

Interface WorkflowService

All Known Implementing Classes:
StandardWorkflowService
@RemoteInterface public interface WorkflowService
WorkflowService provides client invokable methods to workflow services. These methods are executed on the server side.

Supported API: true

Extendable: false

  • Method Details

    • getWorkItems

      QueryResult getWorkItems(WTPrincipal principal) throws WTException, WfException
      Answer an enumeration of work items for a principal

      Supported API: true
      Parameters:
      principal - the assigned-to WTPrincipal used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getUncompletedWorkItems

      QueryResult getUncompletedWorkItems(WTPrincipal principal) throws WTException, WfException
      Answer an enumeration of incomplete work items for a principal

      Supported API: true
      Parameters:
      principal - the assigned-to WTPrincipal used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems(WTPrincipal principal, Role role) throws WTException, WfException
      Answer an enumeration of work items for a principal for a specific role

      Supported API: true
      Parameters:
      principal - the assigned-to WTPrincipal used as search criteria
      role - the Role object used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems(String source) throws WTException, WfException
      Answer an enumeration of work items created by a specific source

      Supported API: true
      Parameters:
      source - the name of the process (theLifeCycleTemplate) that created the WorkItem used as a search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems(Persistable object) throws WTException, WfException
      Answer an enumeration of work items for an object

      Supported API: true
      Parameters:
      object - the persistable lifecyclemanaged object that is used as the search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems(Persistable object, String source) throws WTException, WfException
      Answer an enumeration of work items for an object & source

      Supported API: true
      Parameters:
      object - the persistable lifecyclemanaged object that is used as the search criteria
      source - the name of the process (the LifeCycleTemplate name) that caused the work item to be created used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems(Persistable object, WTPrincipal principal, Role role) throws WTException, WfException
      Get work by object & principal & role

      Supported API: true
      Parameters:
      object - the persistable lifecyclemanaged object that is used as search criteria
      principal - the assigned-to WTPrincipal that is used as search critieria
      role - the role object that is used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems(Persistable object, WTPrincipal principal, String task) throws WTException, WfException
      Get work by object & principal & task

      Supported API: true
      Parameters:
      object - the persistable lifecyclemanaged object that is used as search criteria
      principal - the assigned-to WTPrincipal that is used as search critieria
      task - the task that is used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems(Persistable object, WTPrincipal principal) throws WTException, WfException
      Get work by object & principal

      Supported API: true
      Parameters:
      object - the persistable lifecyclemanaged object that is used as search criteria
      principal - the assigned-to WTPrincipal that is used as search critieria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems(Persistable object, Role role) throws WTException, WfException
      Get work by object & role

      Supported API: true
      Parameters:
      object - the persistable lifecyclemanaged object that is used as search criteria
      role - the role object that is used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getUncompletedWorkItems

      QueryResult getUncompletedWorkItems(Persistable object, Role role) throws WTException, WfException
      Get pending work by object & role

      Supported API: true
      Parameters:
      object - the persistable lifecyclemanaged object that is used as search criteria
      role - the role object that is used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getWorkItems

      QueryResult getWorkItems() throws WTException, WfException
      Answer an enumeration of all pending work items for all users

      Supported API: true
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getUncompletedWorkItems

      QueryResult getUncompletedWorkItems() throws WTException, WfException
      Answer an enumeration of all pending work items for all users

      Supported API: true
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getUncompletedWorkItems

      QueryResult getUncompletedWorkItems(Persistable object, String task) throws WTException, WfException
      Get incomplete work items by object & task

      Supported API: true
      Parameters:
      object - the persistable lifecyclemanaged object that is used as search criteria
      task - the task that is used as search criteria
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • getAssignees

      Vector getAssignees(WfAssignedActivity activity) throws WTException, WfException
      Answer a vector of principals assigned to the activity

      Supported API: true
      Parameters:
      activity -
      Returns:
      Vector
      Throws:
      WTException
      WfException

    • workComplete

      void workComplete(WorkItem workItem, WTPrincipalReference principalRef, Vector eventList) throws WTException, WfException
      Declare a workItem complete and transmit the event(s) to trigger.

      Supported API: true
      Parameters:
      workItem -
      principalRef -
      eventList -
      Throws:
      WTException
      WfException

    • workComplete

      void workComplete(ObjectReference workItemRef, WTPrincipalReference principalRef, Vector eventList) throws WTException, WfException
      Declare a workItem complete and transmit the event(s) to trigger.

      Supported API: true
      Parameters:
      workItemRef -
      principalRef -
      eventList -
      Throws:
      WTException
      WfException

    • markWorkItemComplete

      void markWorkItemComplete(WorkItem workItem, WTPrincipalReference completedBy) throws WTException, WfException
      Deprecated.
      Since R2 Mark the work item complete.


      Supported API: true
      Parameters:
      workItem -
      completedBy - the performer of the work
      Throws:
      WTException
      WfException

    • markWorkItemComplete

      void markWorkItemComplete(Persistable object, WTPrincipal completedBy, Role role) throws WTException, WfException
      Mark the work item defined by user, object & role as complete.

      Supported API: true
      Parameters:
      object - the life cycle managed object associated with the work item
      completedBy - the performer of the work
      role - the role played by the actor
      Throws:
      WTException
      WfException

    • markWorkItemComplete

      void markWorkItemComplete(Persistable object, WTPrincipal completedBy, String task) throws WTException, WfException
      Mark the work item defined by user, object & task as complete.

      Supported API: true
      Parameters:
      object - the life cycle managed object associated with the work item
      completedBy - the performer of the work
      task - the role played by the actor
      Throws:
      WTException
      WfException

    • markWorkItemIncomplete

      void markWorkItemIncomplete(Persistable object, WTPrincipal completedBy, Role role) throws WTException, WfException
      Mark the work item defined by user, object & role as NOT complete.

      Supported API: true
      Parameters:
      object - the life cycle managed object associated with the work item
      completedBy - the performer of the work
      role - the role played by the completedBy principal
      Throws:
      WTException
      WfException

    • acceptAssignment

      void acceptAssignment(WorkItem workItem, WTUser user) throws WTException, WfException


      Supported API: true
      Parameters:
      workItem -
      user -
      Throws:
      WTException
      WfException

    • delegate

      void delegate(WorkItem workItem, WTPrincipal principal) throws WTException, WfException
      Delegate a work item to a new owner

      Supported API: true
      Parameters:
      workItem -
      principal -
      Throws:
      WTException
      WfException

    • sendNotification

      void sendNotification(String msgBody, Vector recipients, Vector roles, Vector actorRoles, ObjectReference activityReference) throws WTException
      send email to a recipient list

      Supported API: true
      Parameters:
      msgBody -
      recipients -
      roles -
      actorRoles -
      activityReference -
      Throws:
      WTException

    • sendNotification

      void sendNotification(String subject, String msgBody, Vector recipients, Vector roles, Vector actorRoles, Vector projects, Vector variables, ObjectReference activityReference) throws WTException
      sendNotification resolves the principals and sends notification to them.

      Supported API: true
      Parameters:
      subject -
      msgBody -
      recipients -
      roles -
      actorRoles -
      projects -
      variables -
      activityReference -
      Throws:
      WTException

    • createWorkListModel

      WfWorkListModel createWorkListModel(String loadAction) throws WTException
      This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

      Supported API: true
      Parameters:
      loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.
      Returns:
      WfWorkListModel
      Throws:
      WTException

    • createWorkListModel

      WfWorkListModel createWorkListModel(String loadAction, Vector groupBy, Vector sortBy) throws WTException
      This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

      Supported API: true
      Parameters:
      loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.
      groupBy - The ordered list of columns to be grouped for the work list. If no grouping is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be grouped. The first column listed in the vector will be the first column grouped.
      sortBy - The ordered list of columns to be sorted for the work list. If no sorting is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be sorted. The first column listed in the vector will be the first column sorted.
      Returns:
      WfWorkListModel
      Throws:
      WTException

    • createOverdueWorkItem

      void createOverdueWorkItem(WfExecutionObject exec_obj) throws WTException
      Creates a work item corresponding to the actions to be taken on an overdue execution object.

      Supported API: true
      Parameters:
      exec_obj -
      Throws:
      WTException

    • reassignActivity

      void reassignActivity(WfAssignedActivity activity) throws WTException
      Reassigns activity to principal referred to by special activity variable.

      Supported API: true
      Parameters:
      activity -
      Throws:
      WTException

    • reassignActivity

      void reassignActivity(WfAssignedActivity activity, WTPrincipal principal) throws WTException
      Reassigns activity to principal referred to principal passed as parameter.

      Supported API: true
      Parameters:
      activity -
      principal -
      Throws:
      WTException

    • createTableModel

      wt.clients.beans.table.WTTableModel createTableModel(String loadAction) throws WTException
      This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

      Supported API: true
      Parameters:
      loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.
      Returns:
      WTTableModel
      Throws:
      WTException

    • createTableModel

      wt.clients.beans.table.WTTableModel createTableModel(String loadAction, Vector groupBy, Vector sortBy) throws WTException
      This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

      Supported API: true
      Parameters:
      loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.
      groupBy - The ordered list of columns to be grouped for the work list. If no grouping is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be grouped. The first column listed in the vector will be the first column grouped.
      sortBy - The ordered list of columns to be sorted for the work list. If no sorting is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be sorted. The first column listed in the vector will be the first column sorted.
      Returns:
      WTTableModel
      Throws:
      WTException

    • createTableModel

      wt.clients.beans.table.WTTableModel createTableModel(String loadAction, Vector groupBy, Vector sortBy, WTObject contextObject) throws WTException
      This method is used to construct a worklist on the server and return it to the client. The created worklist will contain either work items for all users, or work items for the current user.

      Supported API: true
      Parameters:
      loadAction - The type of load action to be performed on the work list. Valid values are 'worklist-load-user' to load work items for the current user, or 'worklist-load-admin' to load work items for all users.
      groupBy - The ordered list of columns to be grouped for the work list. If no grouping is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be grouped. The first column listed in the vector will be the first column grouped.
      sortBy - The ordered list of columns to be sorted for the work list. If no sorting is required then this parameter may be set to 'null' or an empty Vector may be sent in. Otherwise, this parameter takes a vector (of Strings) of column names to be sorted. The first column listed in the vector will be the first column sorted.
      contextObject -
      Returns:
      WTTableModel
      Throws:
      WTException

    • tally

      boolean tally(WfAssignedActivity self, WfTallyType policy, String operator, int value, String event) throws WTException
      This is the tally method that is called from the Custom Routing Event/...Event Firing Expression. It is exposed here for future client customization.

      Supported API: true
      Parameters:
      self -
      policy -
      operator -
      value -
      event -
      Returns:
      boolean
      Throws:
      WTException

    • replaceVariables

      String replaceVariables(String txt, ProcessData variables) throws WTException
      Utility method that replaces values for variables whenever they occur. The parameters are a text String and a ProcessData object that holds the variables whose values must be replaced. In the text, a variable occurrence is represented by {var_name}, where:
      • var_name is the name of the variable
      • the delimiter characters '{' and '}' can be escaped by preceding hem by '\'

      The delimiter characters can be defined in wt.properties. The default are open and close curly braces ('{' and '}').

      Supported API: true

      Parameters:
      txt -
      variables -
      Returns:
      String
      Throws:
      WTException

    • isOffered

      boolean isOffered(WorkItem workItem) throws WTException
      This is the method that indicates whether a WorkItem is offered and capable of being Accepted.

      Supported API: true
      Parameters:
      workItem -
      Returns:
      boolean
      Throws:
      WTException

    • getUncompletedWorkItems

      QueryResult getUncompletedWorkItems(WTPrincipal principal, WTContainerRef context_ref, Integer query_limit, String sort_by_str) throws WTException, WfException
      Answer an enumeration of incomplete work items for a principal within a WTContainer, sorted and only the first nnn number of workitems returned.

      Supported API: true
      Parameters:
      principal - the assigned-to WTPrincipal used as search criteria
      context_ref -
      query_limit -
      sort_by_str -
      Returns:
      QueryResult
      Throws:
      WTException
      WfException

    • sendNotification

      void sendNotification(String subject, String msgBody, Vector recipients, Vector roles, Vector actorRoles, Vector projects, Vector variables, ObjectReference activityReference, String notificationTemplateName, WfExternalRecipientList emailAddrs, WfEmailAttachments attachments) throws WTException
      sendNotification resolves the principals and sends notification to them.

      Supported API: true
      Parameters:
      subject -
      msgBody -
      recipients -
      roles -
      actorRoles -
      projects -
      variables -
      activityReference -
      notificationTemplateName -
      emailAddrs -
      attachments -
      Throws:
      WTException

    • completeActivity

      void completeActivity(ObjectReference self, String events) throws WTException


      Supported API: true Method to complete the activity
      Parameters:
      self -
      events -
      Throws:
      WTException

    • getParticipantRolesInProcess

      List<Role> getParticipantRolesInProcess(ObjectReference wfExecObj) throws WTException
      API to return list of Participant Role for current Process/Activity/Block.

      Supported API: true

      Parameters:
      ObjectReference -
      Returns:
      List
      Throws:
      WTException

    • getParticipantRolePermissions

      HashMap<Object,List<WTRolePermission>> getParticipantRolePermissions(ObjectReference wfExecObj) throws WTException

      API to return list of participant Roles with permissions to assignee on each Role for current Process/Activity/Block.

      Supported API: true

      Parameters:
      ObjectReference -
      Returns:
      HashMap<Object, List>
      Throws:
      WTException

    • getDisplayValue

      String getDisplayValue(Role role, Locale locale) throws WTException
      API returns display value of currently selected Role for current locale
      Supported API: true

      Parameters:
      Locale -
      Role -
      Returns:
      String
      Throws:
      WTException

    • isRoleRequiredForActivity

      Boolean isRoleRequiredForActivity(ObjectReference wfExecObj, Role role) throws WTException
      API returns Boolean(true/false) if assignee object for currently selected Role is required or not Supported API: true
      Parameters:
      ObjectReference -
      Role -
      Returns:
      boolean
      Throws:
      WTException