Class TaskQueryDto

java.lang.Object
com.priint.pubserver.bpm.model.TaskQueryDto

public class TaskQueryDto extends Object
A Object which is send to BPM to get list of CustomTask
  • Constructor Details

  • Method Details

    • addProcessVariable

      public void addProcessVariable(ProcessVariableOperator operator, String name, String value)
      adds new entry to
    • getTaskId

      public String getTaskId()
      Returns:
      String which Restrict to task with the given id.
    • getTaskIds

      public List<String> getTaskIds()
      Returns:
      List of String which Restrict to tasks with any of the given ids.
    • getProcessInstanceId

      public String getProcessInstanceId()
      Returns:
      String which Restrict to tasks that belong to process instances with the given id.
    • getProcessInstanceIdIn

      public List<String> getProcessInstanceIdIn()
      Returns:
      List of String Restrict to tasks that belong to process instances with the given ids.
    • getProcessInstanceBusinessKey

      public String getProcessInstanceBusinessKey()
      Returns:
      String which Restrict to tasks that belong to process instances with the given business key.
    • getProcessInstanceBusinessKeyIn

      public List<String> getProcessInstanceBusinessKeyIn()
      Returns:
      List of String which Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in an array.
    • getProcessInstanceBusinessKeyLike

      public String getProcessInstanceBusinessKeyLike()
      Returns:
      String which Restrict to tasks that have a process instance business key that has the parameter value as a substring.
    • getProcessDefinitionId

      public String getProcessDefinitionId()
      Returns:
      String which Restrict to tasks that belong to a process definition with the given id.
    • getProcessDefinitionKey

      public String getProcessDefinitionKey()
      Returns:
      String which Restrict to tasks that belong to a process definition with the given key.
    • getProcessDefinitionKeyIn

      public List<String> getProcessDefinitionKeyIn()
      Returns:
      List of String which Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list.
    • getProcessDefinitionName

      public String getProcessDefinitionName()
      Returns:
      String which Restrict to tasks that belong to a process definition with the given name.
    • getProcessDefinitionNameLike

      public String getProcessDefinitionNameLike()
      Returns:
      String Restrict to tasks that have a process definition name that has the parameter value as a substring.
    • getExecutionId

      public String getExecutionId()
      Returns:
      String which Restrict to tasks that belong to an execution with the given id.
    • getActivityInstanceIdIn

      public List<String> getActivityInstanceIdIn()
      Returns:
      List of String which only include tasks which belong to one of the passed activity instance ids.
    • getTenantId

      public String getTenantId()
      Returns:
      the tenant id for the task String
    • getTenantIdIn

      public List<String> getTenantIdIn()
      Returns:
      List of String which Restrict to tasks that belong to one of the given tenant ids. The ids need to be in a comma-separated list.
    • getWithoutTenantId

      public Boolean getWithoutTenantId()
      Returns:
      Boolean which only include tasks which belong to no tenant.
    • getAssignee

      public String getAssignee()
      Returns:
      String which Restrict to tasks that the given user is assigned to.
    • getAssigneeExpression

      public String getAssigneeExpression()
      Returns:
      String which Restrict to tasks that the user described by the given expression is assigned to.
    • getAssigneeLike

      public String getAssigneeLike()
      Returns:
      String which Restrict to tasks that have an assignee that has the parameter value as a substring.
    • getAssigneeIn

      public List<String> getAssigneeIn()
      Returns:
      List of String which Only include tasks which are assigned to one of the user ids passed in the array
    • getOwner

      public String getOwner()
      Returns:
      String which Restrict to tasks that the given user owns.
    • getCandidateGroup

      public String getCandidateGroup()
      Returns:
      String which only include tasks that are offered to the given group.
    • getCandidateGroups

      public List<String> getCandidateGroups()
      Returns:
      List of String which Restrict to tasks that are offered to any of the given candidate groups.
    • getWithCandidateGroups

      public Boolean getWithCandidateGroups()
      Returns:
      Boolean which only include tasks which have a candidate group. Value may only be true, as false is the default behavior.
    • getWithoutCandidateGroups

      public Boolean getWithoutCandidateGroups()
      Returns:
      Boolean which only include tasks which have no candidate group. Value may only be true, as false is the default behavior.
    • getWithCandidateUsers

      public Boolean getWithCandidateUsers()
      Returns:
      Boolean which only include tasks which have a candidate user. Value may only be true, as false is the default behavior.
    • getWithoutCandidateUsers

      public Boolean getWithoutCandidateUsers()
      Returns:
      Boolean which only include tasks which have no candidate user. Value may only be true, as false is the default behavior.
    • getCandidateUser

      public String getCandidateUser()
      Returns:
      String which only include tasks that are offered to the given user or to one of his groups.
    • getIncludeAssignedTasks

      public Boolean getIncludeAssignedTasks()
      Returns:
      Boolean which also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s).
    • getAssigned

      public Boolean getAssigned()
      Returns:
      Boolean If set to true, restricts the query to all tasks that are assigned.
    • getUnassigned

      public Boolean getUnassigned()
      Returns:
      Boolean If set to true, restricts the query to all tasks that are unassigned.
    • getTaskDefinitionKey

      public String getTaskDefinitionKey()
      Returns:
      String which Restrict to tasks that have the given key.
    • getTaskDefinitionKeyIn

      public List<String> getTaskDefinitionKeyIn()
      Returns:
      List of String which Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list.
    • getTaskDefinitionKeyLike

      public String getTaskDefinitionKeyLike()
      Returns:
      String which Restrict to tasks that have a key that has the parameter value as a substring.
    • getName

      public String getName()
      Returns:
      String which Restrict to tasks that have the given name.
    • getNameLike

      public String getNameLike()
      Returns:
      String which Restrict to tasks that have a name with the given parameter value as substring.
    • getDueDate

      public Date getDueDate()
      Returns:
      Date which Restrict to tasks that are due on the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.234+0200.
    • getDueAfter

      public Date getDueAfter()
      Returns:
      Date which Restrict to tasks that are due after the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.453+0200.
    • getDueBefore

      public Date getDueBefore()
      Returns:
      Date which Restrict to tasks that are due before the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.667+0200.
    • getCreatedAfter

      public Date getCreatedAfter()
      Returns:
      Date which Restrict to tasks that were created after the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.654+0200.
    • getDelegationState

      public String getDelegationState()
      Returns:
      String which Restrict to tasks that are in the given delegation state. Valid values are PENDING and RESOLVED.
    • getProcessVariables

      public List<VariableQueryDto> getProcessVariables()
      Returns:
      List of VariableQueryDto - array to only include tasks that belong to a process instance with variables with certain values.
    • getOrQueries

      public List<TaskQueryDto> getOrQueries()
      Returns:
      List of TaskQueryDto - array of nested task queries with OR semantics. A task matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a task must fulfill at least one predicate of each query (Conjunctive Normal Form). All task query properties can be used except for: sorting, withCandidateGroups, withoutCandidateGroups, withCandidateUsers, withoutCandidateUsers
    • getSorting

      public List<BpmQuerySorting> getSorting()
      Returns:
      List of BpmQuerySorting - array of criteria to sort the result by. Each element of the array is a JSON object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc.
    • setTaskId

      public void setTaskId(String taskId)
      Parameters:
      taskId - String - Restrict to task with the given id.
    • setTaskIds

      public void setTaskIds(List<String> taskIds)
      Parameters:
      taskIds - List of String - Restrict to tasks with any of the given ids.
    • setProcessInstanceId

      public void setProcessInstanceId(String processInstanceId)
      Parameters:
      processInstanceId - String - Restrict to tasks that belong to process instances with the given id.
    • setProcessInstanceIdIn

      public void setProcessInstanceIdIn(List<String> processInstanceIdIn)
      Parameters:
      processInstanceIdIn - List of String - Restrict to tasks that belong to process instances with the given ids.
    • setProcessInstanceBusinessKey

      public void setProcessInstanceBusinessKey(String processInstanceBusinessKey)
      Parameters:
      processInstanceBusinessKey - String - Restrict to tasks that belong to process instances with the given business key.
    • setProcessInstanceBusinessKeyIn

      public void setProcessInstanceBusinessKeyIn(List<String> processInstanceBusinessKeyIn)
      Parameters:
      processInstanceBusinessKeyIn - List of String - Restrict to tasks that belong to process instances with one of the give business keys.
    • setProcessInstanceBusinessKeyLike

      public void setProcessInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)
      Parameters:
      processInstanceBusinessKeyLike - String - Restrict to tasks that have a process instance business key that has the parameter value as a substring.
    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)
      Parameters:
      processDefinitionId - String - Restrict to tasks that belong to a process definition with the given id.
    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)
      Parameters:
      processDefinitionKey - String - Restrict to tasks that belong to a process definition with the given key.
    • setProcessDefinitionKeyIn

      public void setProcessDefinitionKeyIn(List<String> processDefinitionKeyIn)
      Parameters:
      processDefinitionKeyIn - List of String - Restrict to tasks that belong to a process definition with one of the given keys.
    • setProcessDefinitionName

      public void setProcessDefinitionName(String processDefinitionName)
      Parameters:
      processDefinitionName - String - Restrict to tasks that belong to a process definition with the given name.
    • setProcessDefinitionNameLike

      public void setProcessDefinitionNameLike(String processDefinitionNameLike)
      Parameters:
      processDefinitionNameLike - String - Restrict to tasks that have a process definition name that has the parameter value as a substring.
    • setExecutionId

      public void setExecutionId(String executionId)
      Parameters:
      executionId - String - Restrict to tasks that belong to an execution with the given id.
    • setActivityInstanceIdIn

      public void setActivityInstanceIdIn(List<String> activityInstanceIdIn)
      Parameters:
      activityInstanceIdIn - List of String - Only include tasks which belong to one of the passed activity instance ids.
    • setTenantId

      public void setTenantId(String tenantId)
      Parameters:
      tenantId - String - If not null, the tenant id for the task.
    • setTenantIdIn

      public void setTenantIdIn(List<String> tenantIdIn)
      Parameters:
      tenantIdIn - List of String - Restrict to tasks that belong to one of the given tenant ids.
    • setWithoutTenantId

      public void setWithoutTenantId(Boolean withoutTenantId)
      Parameters:
      withoutTenantId - Boolean - Only include tasks which belong to no tenant. Value may only be true, as false is the default behavior.
    • setAssignee

      public void setAssignee(String assignee)
      Parameters:
      assignee - String - Restrict to tasks that the given user is assigned to.
    • setAssigneeExpression

      public void setAssigneeExpression(String assigneeExpression)
      Parameters:
      assigneeExpression - String - Restrict to tasks that the user described by the given expression is assigned to.
    • setAssigneeLike

      public void setAssigneeLike(String assigneeLike)
      Parameters:
      assigneeLike - String - Restrict to tasks that have an assignee that has the parameter value as a substring.
    • setAssigneeIn

      public void setAssigneeIn(List<String> assigneeIn)
      Parameters:
      assigneeIn - List of String - Only include tasks which are assigned to one of the user ids passed in the array
    • setOwner

      public void setOwner(String owner)
      Parameters:
      owner - String - Restrict to tasks that the given user owns.
    • setCandidateGroup

      public void setCandidateGroup(String candidateGroup)
      Parameters:
      candidateGroup - String - Only include tasks that are offered to the given group.
    • setCandidateGroups

      public void setCandidateGroups(List<String> candidateGroups)
      Parameters:
      candidateGroups - List of String - Restrict to tasks that are offered to any of the given candidate groups.
    • setWithCandidateGroups

      public void setWithCandidateGroups(Boolean withCandidateGroups)
      Parameters:
      withCandidateGroups - Boolean - Only include tasks which have a candidate group. Value may only be true, as false is the default behavior.
    • setWithoutCandidateGroups

      public void setWithoutCandidateGroups(Boolean withoutCandidateGroups)
      Parameters:
      withoutCandidateGroups - Boolean - Only include tasks which have no candidate group. Value may only be true, as false is the default behavior.
    • setWithCandidateUsers

      public void setWithCandidateUsers(Boolean withCandidateUsers)
      Parameters:
      withCandidateUsers - Boolean - Only include tasks which have a candidate user. Value may only be true, as false is the default behavior.
    • setWithoutCandidateUsers

      public void setWithoutCandidateUsers(Boolean withoutCandidateUsers)
      Parameters:
      withoutCandidateUsers - Boolean - Only include tasks which have no candidate user. Value may only be true, as false is the default behavior.
    • setCandidateUser

      public void setCandidateUser(String candidateUser)
      Parameters:
      candidateUser - String - Only include tasks that are offered to the given user or to one of his groups.
    • setIncludeAssignedTasks

      public void setIncludeAssignedTasks(Boolean includeAssignedTasks)
      Parameters:
      includeAssignedTasks - Boolean - Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s).
    • setAssigned

      public void setAssigned(Boolean assigned)
      Parameters:
      assigned - Boolean - If set to true, restricts the query to all tasks that are assigned.
    • setUnassigned

      public void setUnassigned(Boolean unassigned)
      Parameters:
      unassigned - Boolean - If set to true, restricts the query to all tasks that are unassigned.
    • setTaskDefinitionKey

      public void setTaskDefinitionKey(String taskDefinitionKey)
      Parameters:
      taskDefinitionKey - String - Restrict to tasks that have the given key.
    • setTaskDefinitionKeyIn

      public void setTaskDefinitionKeyIn(List<String> taskDefinitionKeyIn)
      Parameters:
      taskDefinitionKeyIn - List of String - Restrict to tasks that have one of the given keys.
    • setTaskDefinitionKeyLike

      public void setTaskDefinitionKeyLike(String taskDefinitionKeyLike)
      Parameters:
      taskDefinitionKeyLike - String - Restrict to tasks that have a key that has the parameter value as a substring.
    • setName

      public void setName(String name)
      Parameters:
      name - String - Restrict to tasks that have the given name.
    • setNameLike

      public void setNameLike(String nameLike)
      Parameters:
      nameLike - String - Restrict to tasks that have a name with the given parameter value as substring.
    • setDueDate

      public void setDueDate(Date dueDate)
      Parameters:
      dueDate - Date - Restrict to tasks that are due on the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.234+0200.
    • setDueAfter

      public void setDueAfter(Date dueAfter)
      Parameters:
      dueAfter - Date - Restrict to tasks that are due after the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.453+0200.
    • setDueBefore

      public void setDueBefore(Date dueBefore)
      Parameters:
      dueBefore - Date - Restrict to tasks that are due before the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.667+0200.
    • setCreatedAfter

      public void setCreatedAfter(Date createdAfter)
      Parameters:
      createdAfter - Date - Restrict to tasks that were created after the given date. By default*, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.654+0200.
    • setDelegationState

      public void setDelegationState(String delegationState)
      Parameters:
      delegationState - String - Restrict to tasks that are in the given delegation state. Valid values are PENDING and RESOLVED.
    • setProcessVariables

      public void setProcessVariables(List<VariableQueryDto> processVariables)
      Parameters:
      processVariables - List of VariableQueryDto - array to only include tasks that belong to a process instance with variables with certain values.
    • setOrQueries

      public void setOrQueries(List<TaskQueryDto> orQueries)
      Parameters:
      orQueries - List of TaskQueryDto - array of nested task queries with OR semantics. A task matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a task must fulfill at least one predicate of each query
    • setSorting

      public void setSorting(List<BpmQuerySorting> sorting)
      Parameters:
      sorting - List of TaskQueryDto - array of criteria to sort the result by.
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • canEqual

      protected boolean canEqual(Object other)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object