Package com.sas.lsaf.workflow.task

Class TaskQuery

java.lang.Object
com.sas.lsaf.workflow.task.TaskQuery
All Implemented Interfaces:
Serializable
public class TaskQuery extends Object implements Serializable
The class that contains the criteria to query process flow tasks.
Since:
2.4
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    TaskQuery.AssigneeType
    The valid values for the assignee type that describes the method to search for user task assignees.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TaskQuery()
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getAssignees()
    Gets the task assignees in which to search for process flow tasks, based on the task assignment.
    TaskQuery.AssigneeType
    getAssigneeType()
    Gets whether to search for the process flow tasks that are assigned to the current user, a specific set of users, or all users.
    Set<String>
    getContextPaths()
    Gets the context paths in which to search for process flow tasks.
    String
    getElementId()
    Gets the process flow task element identifier to query.
    Date
    getFromDueDate()
    Gets the start date of the date range to query process flow tasks, based on the due date.
    int
    getLimit()
    Gets the maximum number of process flow tasks to return.
    String
    getName()
    Gets the process flow task name to query.
    Task.Priority
    getPriority()
    Gets the task priority by which to query the process flow tasks.
    String
    getProcessFlowName()
    Gets the name of the process flow in which to search for tasks.
    Task.TaskStatus
    getStatus()
    Gets the status of the process flow task in which to query.
    Date
    getToDueDate()
    Gets the end date of the date range to query process flow tasks based on due date.
    void
    setAssignees(Set<String> assignees)
    Sets the task assignees in which to search for process flow tasks.
    void
    setAssigneeType(TaskQuery.AssigneeType assigneeType)
    Sets whether to search for the process flow tasks that are assigned to the current user, a specific set of users, or all users.
    void
    setContextPaths(Set<String> contextPaths)
    Sets the context paths in which to search for process flow tasks.
    void
    setElementId(String elementId)
    Sets the process flow task element identifier to query.
    void
    setFromDueDate(Date fromDueDate)
    Sets the start date of the date range to query process flow tasks, based on the due date.
    void
    setLimit(int limit)
    Sets the maximum number of process flow tasks to return.
    void
    setName(String name)
    Sets the process flow task name to query.
    void
    setPriority(Task.Priority priority)
    Sets the task priority by which to query the process flow tasks.
    void
    setProcessFlowName(String processFlowName)
    Sets the name of the process flow in which to search for tasks.
    void
    setStatus(Task.TaskStatus status)
    Sets the status of the process flow task in which to query.
    void
    setToDueDate(Date toDueDate)
    Sets the end date of the date range to query process flow tasks, based on the due date.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TaskQuery

      public TaskQuery()
      Constructor.

  • Method Details

    • getStatus

      public Task.TaskStatus getStatus()
      Gets the status of the process flow task in which to query.
      Returns:
      The status of the process flow task in which to query.

    • setStatus

      public void setStatus(Task.TaskStatus status)
      Sets the status of the process flow task in which to query.
      Parameters:
      status - The status.

    • getElementId

      public String getElementId()
      Gets the process flow task element identifier to query.
      Returns:
      The process flow task element identifier to query.

    • setElementId

      public void setElementId(String elementId)
      Sets the process flow task element identifier to query.
      Parameters:
      elementId - The process flow task element.

    • getName

      public String getName()
      Gets the process flow task name to query.
      Returns:
      The process flow task name to query.

    • setName

      public void setName(String name)
      Sets the process flow task name to query.
      Parameters:
      name - Sets the process flow name to query.

    • getProcessFlowName

      public String getProcessFlowName()
      Gets the name of the process flow in which to search for tasks.
      Returns:
      The name.

    • setProcessFlowName

      public void setProcessFlowName(String processFlowName)
      Sets the name of the process flow in which to search for tasks.
      Parameters:
      processFlowName - The name of the process flow in which to search for tasks.

    • getContextPaths

      public Set<String> getContextPaths()
      Gets the context paths in which to search for process flow tasks.
      Returns:
      The context paths.

    • setContextPaths

      public void setContextPaths(Set<String> contextPaths)
      Sets the context paths in which to search for process flow tasks.
      Parameters:
      contextPaths - The context paths in which to search for process flow tasks.

    • getAssignees

      public Set<String> getAssignees()
      Gets the task assignees in which to search for process flow tasks, based on the task assignment.
      Returns:
      The task assignees.

    • setAssignees

      public void setAssignees(Set<String> assignees)
      Sets the task assignees in which to search for process flow tasks. The maximum number of assignees is 10.
      Parameters:
      assignees - The task assignees by which to search for process flow tasks.

    • getFromDueDate

      public Date getFromDueDate()
      Gets the start date of the date range to query process flow tasks, based on the due date.
      Returns:
      The start date of the date range.

    • setFromDueDate

      public void setFromDueDate(Date fromDueDate)
      Sets the start date of the date range to query process flow tasks, based on the due date.
      Parameters:
      fromDueDate - The start date of the date range to query process flow tasks, based on the due date.

    • getToDueDate

      public Date getToDueDate()
      Gets the end date of the date range to query process flow tasks based on due date.
      Returns:
      The end date of the date range to query process flow tasks based on due date.

    • setToDueDate

      public void setToDueDate(Date toDueDate)
      Sets the end date of the date range to query process flow tasks, based on the due date.
      Parameters:
      toDueDate - The end date of the date range to query process flow tasks, based on the due date.

    • getPriority

      public Task.Priority getPriority()
      Gets the task priority by which to query the process flow tasks.
      Returns:
      The task priority.

    • setPriority

      public void setPriority(Task.Priority priority)
      Sets the task priority by which to query the process flow tasks.
      Parameters:
      priority - The task priority by which to query the process flow tasks.

    • getLimit

      public int getLimit()
      Gets the maximum number of process flow tasks to return.
      Returns:
      The limit The maximum number of process flow tasks to return.

    • setLimit

      public void setLimit(int limit)
      Sets the maximum number of process flow tasks to return.
      Parameters:
      limit - The maximum number of process flow tasks to return.

    • getAssigneeType

      public TaskQuery.AssigneeType getAssigneeType()
      Gets whether to search for the process flow tasks that are assigned to the current user, a specific set of users, or all users. If searching a specific set of users, you must specify users by calling setAssignees(Set).
      Returns:
      Whether to search for process flow tasks assigned to current user, a specific set of users, or all users.

    • setAssigneeType

      public void setAssigneeType(TaskQuery.AssigneeType assigneeType)
      Sets whether to search for the process flow tasks that are assigned to the current user, a specific set of users, or all users. If searching a specific set of users, you must specify users by calling setAssignees(Set).
      Parameters:
      assigneeType - The method to search for the process flow tasks.

    • toString

      public String toString()
      Overrides:
      toString in class Object