Package com.lexmark.saperion.workflow

Interface WorkflowTaskService

All Known Implementing Classes:
AbstractWorkflowTaskDelegateService, WorkflowTaskDelegateService
public interface WorkflowTaskService
This service provides functionality concerning workflow tasks.
Author:
cmerkel

  • Method Details

    • acquireOwnership

      void acquireOwnership(TaskReferenceType taskReference) throws com.lexmark.saperion.exceptions.EcmException
      Acquires the ownership of a task.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • addComment

      void addComment(TaskReferenceType taskReference, String comment) throws com.lexmark.saperion.exceptions.EcmException
      Adds a comment to a workflow task.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      comment - the comment to add
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • forward

      @Deprecated default void forward(TaskReferenceType taskReference, int transitionId, List<com.lexmark.saperion.administration.ActorReferenceType> recipients, String comment, boolean sync) throws com.lexmark.saperion.exceptions.EcmException
      Deprecated.
      use forward(TaskReferenceType, TaskForwardInputType) instead
      Finishes the task execution and forwards the workflow to the next step.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      transitionId - the ID of the next transition to use when forwarding
      recipients - the recipients of the next step if required
      comment - the comment that will be shown in the history
      sync - wait for the workflow operation to complete or not
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • forward

      void forward(TaskReferenceType taskReference, TaskForwardInputType forwardInput) throws com.lexmark.saperion.exceptions.EcmException
      Finishes the task execution and forwards the workflow to the next step.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      forwardInput - the parameters for forwarding
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getIndexData

      Map<String,com.lexmark.saperion.PropertyType> getIndexData(TaskReferenceType taskReference) throws com.lexmark.saperion.exceptions.EcmException
      Returns the task's index data.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      Returns:
      the task's index data
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getProperties

      TaskType getProperties(TaskReferenceType taskReference) throws com.lexmark.saperion.exceptions.EcmException
      Returns the task's properties.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      Returns:
      the task's properties
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getComments

      List<TaskCommentType> getComments(TaskReferenceType taskReference) throws com.lexmark.saperion.exceptions.EcmException
      Returns the task's comments.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      Returns:
      the task's comments
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getTransitions

      List<TransitionDefinitionType> getTransitions(TaskReferenceType taskReference) throws com.lexmark.saperion.exceptions.EcmException
      Returns the task's transition definitions.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      Returns:
      the task's transition definitions
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • revokeOwnership

      void revokeOwnership(TaskReferenceType taskReference) throws com.lexmark.saperion.exceptions.EcmException
      Revokes the ownership of a task.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • updateIndexData

      void updateIndexData(TaskReferenceType taskReference, Map<String,com.lexmark.saperion.PropertyType> properties) throws com.lexmark.saperion.exceptions.EcmException
      Updates the task's index data.
      Parameters:
      taskReference - the reference to the task in base64 encoded form of {"id":"xxx"}
      properties - the task's index data
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getTasksWithReminder

      List<TaskType> getTasksWithReminder() throws com.lexmark.saperion.exceptions.EcmException
      Returns workflow tasks that has reminder
      Returns:
      List of tasks
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getOwnedTasks

      List<TaskType> getOwnedTasks() throws com.lexmark.saperion.exceptions.EcmException
      Returns tasks that owned by requester
      Returns:
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getOverdueTasks

      List<TaskType> getOverdueTasks() throws com.lexmark.saperion.exceptions.EcmException
      Returns list of tasks that are passed their due date
      Returns:
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • createReminderForTask

      TaskType createReminderForTask(TaskReferenceType taskReferenceType, long date) throws com.lexmark.saperion.exceptions.EcmException
      Creates reminder for the given task
      Parameters:
      taskReferenceType -
      date -
      Returns:
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • updateReminderForTask

      TaskType updateReminderForTask(TaskReferenceType taskReferenceType, long date) throws com.lexmark.saperion.exceptions.EcmException
      Update or reset reminder for a given task.
      Parameters:
      taskReferenceType -
      date -
      Returns:
      Throws:
      com.lexmark.saperion.exceptions.EcmException