Package de.elo.ix.client

Class FindTasksInfo

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.FindTasksInfo
All Implemented Interfaces:
Serializable
public class FindTasksInfo extends ValueClass implements Serializable
This class contains the search criteria that are required for locating a task (reminders, workflow tasks or activity).
See Also:

  • Field Details

    • endDateIso

      protected String endDateIso
      Collect tasks up to this date.

    • highestPriority

      protected int highestPriority
      Collect tasks of this or lower priority.
      See Also:

    • inclActivities

      protected boolean inclActivities
      Collect activities.

    • inclDeputy

      protected boolean inclDeputy

      Collect tasks received from users for which the current user is a substitute.

      ELO 12+: inclGroup must be set to true to enable this option.

    • inclGroup

      protected boolean inclGroup
      Collect tasks of the users groups.

    • inclReminders

      protected boolean inclReminders
      Collect reminders.

    • inclWorkflows

      protected boolean inclWorkflows
      Collect workflows.

    • lowestPriority

      protected int lowestPriority
      Collect tasks of this or higher priority.
      See Also:

    • objId

      protected String objId
      Collect tasks for this Sord (ID or GUID).

    • sortOrder

      protected UserTaskSortOrderZ sortOrder
      Controls the sort order or returned arrays. If null, PRIORITY_DATE_NAME is used.
      See Also:

    • startDateIso

      protected String startDateIso
      Collect tasks beginning at this date.

    • overTimeLimit

      protected boolean overTimeLimit
      Collect nodes that exceeded the time limit. Workflow only
      Since:
      6.00.098

    • inclOverTimeForSuperior

      protected boolean inclOverTimeForSuperior
      Collect tasks for a superior as defined in the escalation options. When a workflow task exceeds its time limit, and the current user is assigned in the time limit options of this task, then the user receives this task from findFirstTasks/findNextTasks although she or he is not the owner of the task. If an entire workflow is over time, the user receives the start node of the workflow. This option applies to workflow tasks only.
      Since:
      8.00.010.006

    • userIds

      protected String[] userIds
      IDs of the users which tasks can be collected by the administrator. This member is ignored, if the current user does not have administrator privileges AccessC.FLAG_ADMIN. For administrators, this can be a list of user or groups which tasks should be selected. If the list is null or empty, The tasks of the administrator are collected. In order to collect all tasks from all users, set member allUsers=true.
      Since:
      8.00.012.003

    • inclDeleted

      protected boolean inclDeleted
      Select tasks for deleted folders and documents too.
      Since:
      8.00.012.005

    • allUsers

      protected boolean allUsers
      Collect tasks from all users. This member is ignored, if the current user does not have administrator privileges AccessC.FLAG_ADMIN. If set to true, element userIds is ignored and the tasks of all users are selected.
      Since:
      8.00.020.003

    • sordZ

      protected SordZ sordZ
      Return the associated Sord objects to the selected Tasks. If this member is not null, the Sord objects to the selected Tasks are read from the database. The Sord objects can be found in FindResult.sords and in each UserTask.sord of the array FindResult.tasks. The Sord objects contain the elements defined in this element selector as valid members.
      Since:
      8.00.020.004

    • taskName

      protected String taskName
      Select tasks with this name. The task name of a Reminder is Reminder.name. The task name of an Activity is Activity.name. The task name of a workflow node is WFNode.name and WFCollectNode.nodeName. This element can contain wildcard characters. The underlying database column is by default not indexed. Thus, selecting only by taskName will result in a full table scan.
      Since:
      8.00.028.002

    • updateInUseDate

      protected boolean updateInUseDate
      Update WFNode.inUseDateIso for selected tasks.
      Since:
      9.00.000.025

    • inclActivityTypes

      protected List<String> inclActivityTypes
      Only select activities of the given types
      Since:
      9.00.000.003

    • inclHidden

      protected boolean inclHidden
      Inlcude hidden tasks. Currently this only affects workflows.
      Since:
      9.00.018.006

    • timeLimitBias

      protected int timeLimitBias
      Time limit bias. This value added to each WFNode.timeLimit before evaluating whether the node is over time. It is measured in minutes. Indexserver uses a timeLimitBias of 1min when looking for over-timed nodes to be forwarded automatically through a WFNodeMatrixC.IF_OVERTIME edge.
      Since:
      9.99.009.009

    • findResultAccessMode

      protected FindResultAccessMode findResultAccessMode
      Describes how the client application will access the results.
      Since:
      11.00.000.033

  • Constructor Details

    • FindTasksInfo

      public FindTasksInfo()

    • FindTasksInfo

      public FindTasksInfo(FindTasksInfo rhs)

  • Method Details

    • getEndDateIso

      public String getEndDateIso()

    • setEndDateIso

      public void setEndDateIso(String endDateIso)

    • getHighestPriority

      public int getHighestPriority()

    • setHighestPriority

      public void setHighestPriority(int highestPriority)

    • isInclActivities

      public boolean isInclActivities()

    • setInclActivities

      public void setInclActivities(boolean inclActivities)

    • isInclDeputy

      public boolean isInclDeputy()

    • setInclDeputy

      public void setInclDeputy(boolean inclDeputy)

    • isInclGroup

      public boolean isInclGroup()

    • setInclGroup

      public void setInclGroup(boolean inclGroup)

    • isInclReminders

      public boolean isInclReminders()

    • setInclReminders

      public void setInclReminders(boolean inclReminders)

    • isInclWorkflows

      public boolean isInclWorkflows()

    • setInclWorkflows

      public void setInclWorkflows(boolean inclWorkflows)

    • getLowestPriority

      public int getLowestPriority()

    • setLowestPriority

      public void setLowestPriority(int lowestPriority)

    • getObjId

      public String getObjId()

    • setObjId

      public void setObjId(String objId)

    • getSortOrder

      public UserTaskSortOrderZ getSortOrder()

    • setSortOrder

      public void setSortOrder(UserTaskSortOrderZ sortOrder)

    • getStartDateIso

      public String getStartDateIso()

    • setStartDateIso

      public void setStartDateIso(String startDateIso)

    • isOverTimeLimit

      public boolean isOverTimeLimit()

    • setOverTimeLimit

      public void setOverTimeLimit(boolean overTimeLimit)

    • isInclOverTimeForSuperior

      public boolean isInclOverTimeForSuperior()

    • setInclOverTimeForSuperior

      public void setInclOverTimeForSuperior(boolean inclOverTimeForSuperior)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getUserIds

      public String[] getUserIds()

    • setUserIds

      public void setUserIds(String[] userIds)

    • isInclDeleted

      public boolean isInclDeleted()

    • setInclDeleted

      public void setInclDeleted(boolean inclDeleted)

    • isAllUsers

      public boolean isAllUsers()

    • setAllUsers

      public void setAllUsers(boolean allUsers)

    • getSordZ

      public SordZ getSordZ()

    • setSordZ

      public void setSordZ(SordZ sordZ)

    • getTaskName

      public String getTaskName()

    • setTaskName

      public void setTaskName(String taskName)

    • isUpdateInUseDate

      public boolean isUpdateInUseDate()

    • setUpdateInUseDate

      public void setUpdateInUseDate(boolean updateInUseDate)

    • isInclHidden

      public boolean isInclHidden()

    • setInclHidden

      public void setInclHidden(boolean inclHidden)

    • getInclActivityTypes

      public List<String> getInclActivityTypes()

    • setInclActivityTypes

      public void setInclActivityTypes(List<String> inclActivityTypes)

    • getTimeLimitBias

      public int getTimeLimitBias()

    • setTimeLimitBias

      public void setTimeLimitBias(int timeLimitBias)

    • getFindResultAccessMode

      public FindResultAccessMode getFindResultAccessMode()

    • setFindResultAccessMode

      public void setFindResultAccessMode(FindResultAccessMode findResultAccessMode)