Package com.lexmark.saperion.client.workflow

Interface WorkflowTaskClient

All Known Implementing Classes:
WorkflowTaskClientImpl
public interface WorkflowTaskClient
This client provides functionality for a given workflow task.
Author:
jschwarz

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    acquireOwnership()
    This method acquires the ownership of the task for the current user.
    void
    addComment(String comment)
    This method adds a comment to the workflow task.
    TaskType
    createReminderForTask(long date)
    Creates reminder for given task
    default void
    forward()
    This method forwards a task.
    default void
    forward(int transitionId)
    This method finishes the task execution and forwards the workflow to the next step.
    default void
    forward(int transitionId, List<com.lexmark.saperion.administration.ActorReferenceType> recipients, String comment)
    This method finishes the task execution and forwards the workflow to the next step.
    void
    forward(int transitionId, List<com.lexmark.saperion.administration.ActorReferenceType> recipients, String comment, boolean sync)
    This method finishes the task execution and forwards the workflow to the next step.
    default void
    forward(List<com.lexmark.saperion.administration.ActorReferenceType> recipients)
    This method finishes the task execution and forwards the workflow to the next step.
    List<TaskCommentType>
    getComments()
    This method returns the task's comments.
    List<TaskType>
    getOverdueTasks()
    Returns tasks that owned by requester
    List<TaskType>
    getOwnedTasks()
    Returns List of tasks that are owned by requester
    List<TaskType>
    getTasksWithReminder()
    Returns List of tasks that have reminders set
    List<TransitionDefinitionType>
    getTransitions()
    This method returns the task's forward transition definitions.
    TaskType
    load()
    This method returns the task's properties.
    void
    revokeOwnership()
    This method revokes the ownership of the task from the current user.
    void
    updateIndexData(Map<String,com.lexmark.saperion.PropertyType> properties)
    This method updates the task's index data.
    TaskType
    updateReminderForTask(long date)
    Update or reset reminder for a given task.

  • Method Details

    • acquireOwnership

      void acquireOwnership() throws com.lexmark.saperion.exceptions.EcmException
      This method acquires the ownership of the task for the current user.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • addComment

      void addComment(String comment) throws com.lexmark.saperion.exceptions.EcmException
      This method adds a comment to the workflow task.
      Parameters:
      comment - the comment
      Throws:
      com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred
      com.lexmark.saperion.exceptions.EcmException

    • forward

      void forward(int transitionId, List<com.lexmark.saperion.administration.ActorReferenceType> recipients, String comment, boolean sync) throws com.lexmark.saperion.exceptions.EcmException
      This method finishes the task execution and forwards the workflow to the next step.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • forward

      default void forward(int transitionId, List<com.lexmark.saperion.administration.ActorReferenceType> recipients, String comment) throws com.lexmark.saperion.exceptions.EcmException
      This method finishes the task execution and forwards the workflow to the next step.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • forward

      default void forward(List<com.lexmark.saperion.administration.ActorReferenceType> recipients) throws com.lexmark.saperion.exceptions.EcmException
      This method finishes the task execution and forwards the workflow to the next step.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • forward

      default void forward(int transitionId) throws com.lexmark.saperion.exceptions.EcmException
      This method finishes the task execution and forwards the workflow to the next step.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • forward

      default void forward() throws com.lexmark.saperion.exceptions.EcmException
      This method forwards a task. The transition is determined by the server.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • load

      TaskType load() throws com.lexmark.saperion.exceptions.EcmException
      This method returns the task's properties.
      Returns:
      the task's properties
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • getComments

      List<TaskCommentType> getComments() throws com.lexmark.saperion.exceptions.EcmException
      This method returns the task's comments.
      Returns:
      the task's comments
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • getTransitions

      List<TransitionDefinitionType> getTransitions() throws com.lexmark.saperion.exceptions.EcmException
      This method returns the task's forward transition definitions.
      Returns:
      the task's forward transition definitions
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • revokeOwnership

      void revokeOwnership() throws com.lexmark.saperion.exceptions.EcmException
      This method revokes the ownership of the task from the current user.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • updateIndexData

      void updateIndexData(Map<String,com.lexmark.saperion.PropertyType> properties) throws com.lexmark.saperion.exceptions.EcmException
      This method updates the task's index data.
      Parameters:
      properties - the task's index data
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • getTasksWithReminder

      List<TaskType> getTasksWithReminder() throws com.lexmark.saperion.exceptions.EcmException
      Returns List of tasks that have reminders set
      Returns:
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getOwnedTasks

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

    • getOverdueTasks

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

    • createReminderForTask

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

    • updateReminderForTask

      TaskType updateReminderForTask(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