Class TaskQueryDto


  • public class TaskQueryDto
    extends Object
    A Task query which defines a group of Tasks.
    • Constructor Detail

      • TaskQueryDto

        public TaskQueryDto()
    • Method Detail

      • getTaskId

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

        public void setTaskId​(String taskId)
      • getTaskIdIn

        public List<String> getTaskIdIn()
        Restrict to tasks with any of the given ids.
        Returns:
        taskIdIn
      • setTaskIdIn

        public void setTaskIdIn​(List<String> taskIdIn)
      • getProcessInstanceId

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

        public void setProcessInstanceId​(String processInstanceId)
      • addProcessInstanceIdInItem

        public TaskQueryDto addProcessInstanceIdInItem​(String processInstanceIdInItem)
      • getProcessInstanceIdIn

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

        public void setProcessInstanceIdIn​(List<String> processInstanceIdIn)
      • processInstanceBusinessKey

        public TaskQueryDto processInstanceBusinessKey​(String processInstanceBusinessKey)
      • getProcessInstanceBusinessKey

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

        public void setProcessInstanceBusinessKey​(String processInstanceBusinessKey)
      • processInstanceBusinessKeyExpression

        public TaskQueryDto processInstanceBusinessKeyExpression​(String processInstanceBusinessKeyExpression)
      • getProcessInstanceBusinessKeyExpression

        public String getProcessInstanceBusinessKeyExpression()
        Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
        Returns:
        processInstanceBusinessKeyExpression
      • setProcessInstanceBusinessKeyExpression

        public void setProcessInstanceBusinessKeyExpression​(String processInstanceBusinessKeyExpression)
      • processInstanceBusinessKeyIn

        public TaskQueryDto processInstanceBusinessKeyIn​(List<String> processInstanceBusinessKeyIn)
      • addProcessInstanceBusinessKeyInItem

        public TaskQueryDto addProcessInstanceBusinessKeyInItem​(String processInstanceBusinessKeyInItem)
      • getProcessInstanceBusinessKeyIn

        public List<String> getProcessInstanceBusinessKeyIn()
        Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list.
        Returns:
        processInstanceBusinessKeyIn
      • setProcessInstanceBusinessKeyIn

        public void setProcessInstanceBusinessKeyIn​(List<String> processInstanceBusinessKeyIn)
      • processInstanceBusinessKeyLike

        public TaskQueryDto processInstanceBusinessKeyLike​(String processInstanceBusinessKeyLike)
      • getProcessInstanceBusinessKeyLike

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

        public void setProcessInstanceBusinessKeyLike​(String processInstanceBusinessKeyLike)
      • processInstanceBusinessKeyLikeExpression

        public TaskQueryDto processInstanceBusinessKeyLikeExpression​(String processInstanceBusinessKeyLikeExpression)
      • getProcessInstanceBusinessKeyLikeExpression

        public String getProcessInstanceBusinessKeyLikeExpression()
        Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
        Returns:
        processInstanceBusinessKeyLikeExpression
      • setProcessInstanceBusinessKeyLikeExpression

        public void setProcessInstanceBusinessKeyLikeExpression​(String processInstanceBusinessKeyLikeExpression)
      • processDefinitionId

        public TaskQueryDto processDefinitionId​(String processDefinitionId)
      • getProcessDefinitionId

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

        public void setProcessDefinitionId​(String processDefinitionId)
      • processDefinitionKey

        public TaskQueryDto processDefinitionKey​(String processDefinitionKey)
      • getProcessDefinitionKey

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

        public void setProcessDefinitionKey​(String processDefinitionKey)
      • processDefinitionKeyIn

        public TaskQueryDto processDefinitionKeyIn​(List<String> processDefinitionKeyIn)
      • addProcessDefinitionKeyInItem

        public TaskQueryDto addProcessDefinitionKeyInItem​(String processDefinitionKeyInItem)
      • getProcessDefinitionKeyIn

        public List<String> getProcessDefinitionKeyIn()
        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.
        Returns:
        processDefinitionKeyIn
      • setProcessDefinitionKeyIn

        public void setProcessDefinitionKeyIn​(List<String> processDefinitionKeyIn)
      • processDefinitionName

        public TaskQueryDto processDefinitionName​(String processDefinitionName)
      • getProcessDefinitionName

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

        public void setProcessDefinitionName​(String processDefinitionName)
      • processDefinitionNameLike

        public TaskQueryDto processDefinitionNameLike​(String processDefinitionNameLike)
      • getProcessDefinitionNameLike

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

        public void setProcessDefinitionNameLike​(String processDefinitionNameLike)
      • getExecutionId

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

        public void setExecutionId​(String executionId)
      • getCaseInstanceId

        public String getCaseInstanceId()
        Restrict to tasks that belong to case instances with the given id.
        Returns:
        caseInstanceId
      • setCaseInstanceId

        public void setCaseInstanceId​(String caseInstanceId)
      • caseInstanceBusinessKey

        public TaskQueryDto caseInstanceBusinessKey​(String caseInstanceBusinessKey)
      • getCaseInstanceBusinessKey

        public String getCaseInstanceBusinessKey()
        Restrict to tasks that belong to case instances with the given business key.
        Returns:
        caseInstanceBusinessKey
      • setCaseInstanceBusinessKey

        public void setCaseInstanceBusinessKey​(String caseInstanceBusinessKey)
      • caseInstanceBusinessKeyLike

        public TaskQueryDto caseInstanceBusinessKeyLike​(String caseInstanceBusinessKeyLike)
      • getCaseInstanceBusinessKeyLike

        public String getCaseInstanceBusinessKeyLike()
        Restrict to tasks that have a case instance business key that has the parameter value as a substring.
        Returns:
        caseInstanceBusinessKeyLike
      • setCaseInstanceBusinessKeyLike

        public void setCaseInstanceBusinessKeyLike​(String caseInstanceBusinessKeyLike)
      • getCaseDefinitionId

        public String getCaseDefinitionId()
        Restrict to tasks that belong to a case definition with the given id.
        Returns:
        caseDefinitionId
      • setCaseDefinitionId

        public void setCaseDefinitionId​(String caseDefinitionId)
      • getCaseDefinitionKey

        public String getCaseDefinitionKey()
        Restrict to tasks that belong to a case definition with the given key.
        Returns:
        caseDefinitionKey
      • setCaseDefinitionKey

        public void setCaseDefinitionKey​(String caseDefinitionKey)
      • caseDefinitionName

        public TaskQueryDto caseDefinitionName​(String caseDefinitionName)
      • getCaseDefinitionName

        public String getCaseDefinitionName()
        Restrict to tasks that belong to a case definition with the given name.
        Returns:
        caseDefinitionName
      • setCaseDefinitionName

        public void setCaseDefinitionName​(String caseDefinitionName)
      • caseDefinitionNameLike

        public TaskQueryDto caseDefinitionNameLike​(String caseDefinitionNameLike)
      • getCaseDefinitionNameLike

        public String getCaseDefinitionNameLike()
        Restrict to tasks that have a case definition name that has the parameter value as a substring.
        Returns:
        caseDefinitionNameLike
      • setCaseDefinitionNameLike

        public void setCaseDefinitionNameLike​(String caseDefinitionNameLike)
      • getCaseExecutionId

        public String getCaseExecutionId()
        Restrict to tasks that belong to a case execution with the given id.
        Returns:
        caseExecutionId
      • setCaseExecutionId

        public void setCaseExecutionId​(String caseExecutionId)
      • addActivityInstanceIdInItem

        public TaskQueryDto addActivityInstanceIdInItem​(String activityInstanceIdInItem)
      • getActivityInstanceIdIn

        public List<String> getActivityInstanceIdIn()
        Only include tasks which belong to one of the passed and comma-separated activity instance ids.
        Returns:
        activityInstanceIdIn
      • setActivityInstanceIdIn

        public void setActivityInstanceIdIn​(List<String> activityInstanceIdIn)
      • getTenantIdIn

        public List<String> getTenantIdIn()
        Only include tasks which belong to one of the passed and comma-separated tenant ids.
        Returns:
        tenantIdIn
      • setTenantIdIn

        public void setTenantIdIn​(List<String> tenantIdIn)
      • getWithoutTenantId

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

        public void setWithoutTenantId​(Boolean withoutTenantId)
      • getAssignee

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

        public void setAssignee​(String assignee)
      • assigneeExpression

        public TaskQueryDto assigneeExpression​(String assigneeExpression)
      • getAssigneeExpression

        public String getAssigneeExpression()
        Restrict to tasks that the user described by the given expression is assigned to. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
        Returns:
        assigneeExpression
      • setAssigneeExpression

        public void setAssigneeExpression​(String assigneeExpression)
      • getAssigneeLike

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

        public void setAssigneeLike​(String assigneeLike)
      • assigneeLikeExpression

        public TaskQueryDto assigneeLikeExpression​(String assigneeLikeExpression)
      • getAssigneeLikeExpression

        public String getAssigneeLikeExpression()
        Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
        Returns:
        assigneeLikeExpression
      • setAssigneeLikeExpression

        public void setAssigneeLikeExpression​(String assigneeLikeExpression)
      • getAssigneeIn

        public List<String> getAssigneeIn()
        Only include tasks which are assigned to one of the passed and comma-separated user ids.
        Returns:
        assigneeIn
      • setAssigneeIn

        public void setAssigneeIn​(List<String> assigneeIn)
      • addAssigneeNotInItem

        public TaskQueryDto addAssigneeNotInItem​(String assigneeNotInItem)
      • getAssigneeNotIn

        public List<String> getAssigneeNotIn()
        Only include tasks which are not assigned to one of the passed and comma-separated user ids.
        Returns:
        assigneeNotIn
      • setAssigneeNotIn

        public void setAssigneeNotIn​(List<String> assigneeNotIn)
      • getOwner

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

        public void setOwner​(String owner)
      • getOwnerExpression

        public String getOwnerExpression()
        Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
        Returns:
        ownerExpression
      • setOwnerExpression

        public void setOwnerExpression​(String ownerExpression)
      • getCandidateGroup

        public String getCandidateGroup()
        Only include tasks that are offered to the given group.
        Returns:
        candidateGroup
      • setCandidateGroup

        public void setCandidateGroup​(String candidateGroup)
      • candidateGroupExpression

        public TaskQueryDto candidateGroupExpression​(String candidateGroupExpression)
      • getCandidateGroupExpression

        public String getCandidateGroupExpression()
        Only include tasks that are offered to the group described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
        Returns:
        candidateGroupExpression
      • setCandidateGroupExpression

        public void setCandidateGroupExpression​(String candidateGroupExpression)
      • getCandidateUser

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

        public void setCandidateUser​(String candidateUser)
      • candidateUserExpression

        public TaskQueryDto candidateUserExpression​(String candidateUserExpression)
      • getCandidateUserExpression

        public String getCandidateUserExpression()
        Only include tasks that are offered to the user described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
        Returns:
        candidateUserExpression
      • setCandidateUserExpression

        public void setCandidateUserExpression​(String candidateUserExpression)
      • includeAssignedTasks

        public TaskQueryDto includeAssignedTasks​(Boolean includeAssignedTasks)
      • getIncludeAssignedTasks

        public Boolean getIncludeAssignedTasks()
        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).
        Returns:
        includeAssignedTasks
      • setIncludeAssignedTasks

        public void setIncludeAssignedTasks​(Boolean includeAssignedTasks)
      • getInvolvedUser

        public String getInvolvedUser()
        Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee).
        Returns:
        involvedUser
      • setInvolvedUser

        public void setInvolvedUser​(String involvedUser)
      • involvedUserExpression

        public TaskQueryDto involvedUserExpression​(String involvedUserExpression)
      • getInvolvedUserExpression

        public String getInvolvedUserExpression()
        Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions.
        Returns:
        involvedUserExpression
      • setInvolvedUserExpression

        public void setInvolvedUserExpression​(String involvedUserExpression)
      • getAssigned

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

        public void setAssigned​(Boolean assigned)
      • getUnassigned

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

        public void setUnassigned​(Boolean unassigned)
      • getTaskDefinitionKey

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

        public void setTaskDefinitionKey​(String taskDefinitionKey)
      • addTaskDefinitionKeyInItem

        public TaskQueryDto addTaskDefinitionKeyInItem​(String taskDefinitionKeyInItem)
      • getTaskDefinitionKeyIn

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

        public void setTaskDefinitionKeyIn​(List<String> taskDefinitionKeyIn)
      • taskDefinitionKeyLike

        public TaskQueryDto taskDefinitionKeyLike​(String taskDefinitionKeyLike)
      • getTaskDefinitionKeyLike

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

        public void setTaskDefinitionKeyLike​(String taskDefinitionKeyLike)
      • getName

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

        public void setName​(String name)
      • getNameNotEqual

        public String getNameNotEqual()
        Restrict to tasks that do not have the given name.
        Returns:
        nameNotEqual
      • setNameNotEqual

        public void setNameNotEqual​(String nameNotEqual)
      • getNameLike

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

        public void setNameLike​(String nameLike)
      • getNameNotLike

        public String getNameNotLike()
        Restrict to tasks that do not have a name with the given parameter value as substring.
        Returns:
        nameNotLike
      • setNameNotLike

        public void setNameNotLike​(String nameNotLike)
      • getDescription

        public String getDescription()
        Restrict to tasks that have the given description.
        Returns:
        description
      • setDescription

        public void setDescription​(String description)
      • getDescriptionLike

        public String getDescriptionLike()
        Restrict to tasks that have a description that has the parameter value as a substring.
        Returns:
        descriptionLike
      • setDescriptionLike

        public void setDescriptionLike​(String descriptionLike)
      • getPriority

        public Integer getPriority()
        Restrict to tasks that have the given priority.
        Returns:
        priority
      • setPriority

        public void setPriority​(Integer priority)
      • getMaxPriority

        public Integer getMaxPriority()
        Restrict to tasks that have a lower or equal priority.
        Returns:
        maxPriority
      • setMaxPriority

        public void setMaxPriority​(Integer maxPriority)
      • getMinPriority

        public Integer getMinPriority()
        Restrict to tasks that have a higher or equal priority.
        Returns:
        minPriority
      • setMinPriority

        public void setMinPriority​(Integer minPriority)
      • getDueDate

        public Date getDueDate()
        Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.546+0200`.
        Returns:
        dueDate
      • setDueDate

        public void setDueDate​(Date dueDate)
      • getDueDateExpression

        public String getDueDateExpression()
        Restrict to tasks that are due on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        dueDateExpression
      • setDueDateExpression

        public void setDueDateExpression​(String dueDateExpression)
      • getDueAfter

        public Date getDueAfter()
        Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.435+0200`.
        Returns:
        dueAfter
      • setDueAfter

        public void setDueAfter​(Date dueAfter)
      • dueAfterExpression

        public TaskQueryDto dueAfterExpression​(String dueAfterExpression)
      • getDueAfterExpression

        public String getDueAfterExpression()
        Restrict to tasks that are due after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        dueAfterExpression
      • setDueAfterExpression

        public void setDueAfterExpression​(String dueAfterExpression)
      • getDueBefore

        public Date getDueBefore()
        Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.243+0200`.
        Returns:
        dueBefore
      • setDueBefore

        public void setDueBefore​(Date dueBefore)
      • dueBeforeExpression

        public TaskQueryDto dueBeforeExpression​(String dueBeforeExpression)
      • getDueBeforeExpression

        public String getDueBeforeExpression()
        Restrict to tasks that are due before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        dueBeforeExpression
      • setDueBeforeExpression

        public void setDueBeforeExpression​(String dueBeforeExpression)
      • getWithoutDueDate

        public Boolean getWithoutDueDate()
        Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior.
        Returns:
        withoutDueDate
      • setWithoutDueDate

        public void setWithoutDueDate​(Boolean withoutDueDate)
      • getFollowUpDate

        public Date getFollowUpDate()
        Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`.
        Returns:
        followUpDate
      • setFollowUpDate

        public void setFollowUpDate​(Date followUpDate)
      • followUpDateExpression

        public TaskQueryDto followUpDateExpression​(String followUpDateExpression)
      • getFollowUpDateExpression

        public String getFollowUpDateExpression()
        Restrict to tasks that have a followUp date on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        followUpDateExpression
      • setFollowUpDateExpression

        public void setFollowUpDateExpression​(String followUpDateExpression)
      • getFollowUpAfter

        public Date getFollowUpAfter()
        Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.542+0200`.
        Returns:
        followUpAfter
      • setFollowUpAfter

        public void setFollowUpAfter​(Date followUpAfter)
      • followUpAfterExpression

        public TaskQueryDto followUpAfterExpression​(String followUpAfterExpression)
      • getFollowUpAfterExpression

        public String getFollowUpAfterExpression()
        Restrict to tasks that have a followUp date after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        followUpAfterExpression
      • setFollowUpAfterExpression

        public void setFollowUpAfterExpression​(String followUpAfterExpression)
      • getFollowUpBefore

        public String getFollowUpBefore()
        Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.234+0200`.
        Returns:
        followUpBefore
      • setFollowUpBefore

        public void setFollowUpBefore​(String followUpBefore)
      • followUpBeforeExpression

        public TaskQueryDto followUpBeforeExpression​(String followUpBeforeExpression)
      • getFollowUpBeforeExpression

        public String getFollowUpBeforeExpression()
        Restrict to tasks that have a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        followUpBeforeExpression
      • setFollowUpBeforeExpression

        public void setFollowUpBeforeExpression​(String followUpBeforeExpression)
      • followUpBeforeOrNotExistent

        public TaskQueryDto followUpBeforeOrNotExistent​(Date followUpBeforeOrNotExistent)
      • getFollowUpBeforeOrNotExistent

        public Date getFollowUpBeforeOrNotExistent()
        Restrict to tasks that have no followUp date or a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.432+0200`. The typical use case is to query all `active` tasks for a user for a given date.
        Returns:
        followUpBeforeOrNotExistent
      • setFollowUpBeforeOrNotExistent

        public void setFollowUpBeforeOrNotExistent​(Date followUpBeforeOrNotExistent)
      • followUpBeforeOrNotExistentExpression

        public TaskQueryDto followUpBeforeOrNotExistentExpression​(String followUpBeforeOrNotExistentExpression)
      • getFollowUpBeforeOrNotExistentExpression

        public String getFollowUpBeforeOrNotExistentExpression()
        Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        followUpBeforeOrNotExistentExpression
      • setFollowUpBeforeOrNotExistentExpression

        public void setFollowUpBeforeOrNotExistentExpression​(String followUpBeforeOrNotExistentExpression)
      • getCreatedOn

        public Date getCreatedOn()
        Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.324+0200`.
        Returns:
        createdOn
      • setCreatedOn

        public void setCreatedOn​(Date createdOn)
      • createdOnExpression

        public TaskQueryDto createdOnExpression​(String createdOnExpression)
      • getCreatedOnExpression

        public String getCreatedOnExpression()
        Restrict to tasks that were created on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        createdOnExpression
      • setCreatedOnExpression

        public void setCreatedOnExpression​(String createdOnExpression)
      • getCreatedAfter

        public Date getCreatedAfter()
        Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`.
        Returns:
        createdAfter
      • setCreatedAfter

        public void setCreatedAfter​(Date createdAfter)
      • createdAfterExpression

        public TaskQueryDto createdAfterExpression​(String createdAfterExpression)
      • getCreatedAfterExpression

        public String getCreatedAfterExpression()
        Restrict to tasks that were created after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        createdAfterExpression
      • setCreatedAfterExpression

        public void setCreatedAfterExpression​(String createdAfterExpression)
      • getCreatedBefore

        public Date getCreatedBefore()
        Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`.
        Returns:
        createdBefore
      • setCreatedBefore

        public void setCreatedBefore​(Date createdBefore)
      • createdBeforeExpression

        public TaskQueryDto createdBeforeExpression​(String createdBeforeExpression)
      • getCreatedBeforeExpression

        public String getCreatedBeforeExpression()
        Restrict to tasks that were created before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        createdBeforeExpression
      • setCreatedBeforeExpression

        public void setCreatedBeforeExpression​(String createdBeforeExpression)
      • getUpdatedAfter

        public Date getUpdatedAfter()
        Restrict to tasks that were updated after the given date. Every action that fires a [task update event](https://docs.camunda.org/manual/7.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`.
        Returns:
        updatedAfter
      • setUpdatedAfter

        public void setUpdatedAfter​(Date updatedAfter)
      • updatedAfterExpression

        public TaskQueryDto updatedAfterExpression​(String updatedAfterExpression)
      • getUpdatedAfterExpression

        public String getUpdatedAfterExpression()
        Restrict to tasks that were updated after the date described by the given expression. Every action that fires a [task update event](https://docs.camunda.org/manual/7.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object.
        Returns:
        updatedAfterExpression
      • setUpdatedAfterExpression

        public void setUpdatedAfterExpression​(String updatedAfterExpression)
      • getDelegationState

        public TaskQueryDto.DelegationStateEnum getDelegationState()
        Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`.
        Returns:
        delegationState
      • addCandidateGroupsItem

        public TaskQueryDto addCandidateGroupsItem​(String candidateGroupsItem)
      • getCandidateGroups

        public List<String> getCandidateGroups()
        Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example `developers,support,sales`.
        Returns:
        candidateGroups
      • setCandidateGroups

        public void setCandidateGroups​(List<String> candidateGroups)
      • candidateGroupsExpression

        public TaskQueryDto candidateGroupsExpression​(String candidateGroupsExpression)
      • getCandidateGroupsExpression

        public String getCandidateGroupsExpression()
        Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to `java.util.List` of Strings.
        Returns:
        candidateGroupsExpression
      • setCandidateGroupsExpression

        public void setCandidateGroupsExpression​(String candidateGroupsExpression)
      • withCandidateGroups

        public TaskQueryDto withCandidateGroups​(Boolean withCandidateGroups)
      • getWithCandidateGroups

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

        public void setWithCandidateGroups​(Boolean withCandidateGroups)
      • withoutCandidateGroups

        public TaskQueryDto withoutCandidateGroups​(Boolean withoutCandidateGroups)
      • getWithoutCandidateGroups

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

        public void setWithoutCandidateGroups​(Boolean withoutCandidateGroups)
      • getWithCandidateUsers

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

        public void setWithCandidateUsers​(Boolean withCandidateUsers)
      • withoutCandidateUsers

        public TaskQueryDto withoutCandidateUsers​(Boolean withoutCandidateUsers)
      • getWithoutCandidateUsers

        public Boolean getWithoutCandidateUsers()
        Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior.
        Returns:
        withoutCandidateUsers
      • setWithoutCandidateUsers

        public void setWithoutCandidateUsers​(Boolean withoutCandidateUsers)
      • getActive

        public Boolean getActive()
        Only include active tasks. Value may only be `true`, as `false` is the default behavior.
        Returns:
        active
      • setActive

        public void setActive​(Boolean active)
      • getSuspended

        public Boolean getSuspended()
        Only include suspended tasks. Value may only be `true`, as `false` is the default behavior.
        Returns:
        suspended
      • setSuspended

        public void setSuspended​(Boolean suspended)
      • getTaskVariables

        public List<VariableQueryParameterDto> getTaskVariables()
        A JSON array to only include tasks that have variables with certain values. The array consists of JSON objects with three properties `name`, `operator` and `value`. `name` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. `value` may be of type `String`, `Number` or `Boolean`. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
        Returns:
        taskVariables
      • getProcessVariables

        public List<VariableQueryParameterDto> getProcessVariables()
        A JSON array to only include tasks that belong to a process instance with variables with certain values. The array consists of JSON objects with three properties `name`, `operator` and `value`. `name` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. `value` may be of type `String`, `Number` or `Boolean`. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`; `notLike`. `key` and `value` may not contain underscore or comma characters.
        Returns:
        processVariables
      • getCaseInstanceVariables

        public List<VariableQueryParameterDto> getCaseInstanceVariables()
        A JSON array to only include tasks that belong to a case instance with variables with certain values. The array consists of JSON objects with three properties `name`, `operator` and `value`. `name` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. `value` may be of type `String`, `Number` or `Boolean`. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters.
        Returns:
        caseInstanceVariables
      • variableNamesIgnoreCase

        public TaskQueryDto variableNamesIgnoreCase​(Boolean variableNamesIgnoreCase)
      • getVariableNamesIgnoreCase

        public Boolean getVariableNamesIgnoreCase()
        Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal.
        Returns:
        variableNamesIgnoreCase
      • setVariableNamesIgnoreCase

        public void setVariableNamesIgnoreCase​(Boolean variableNamesIgnoreCase)
      • variableValuesIgnoreCase

        public TaskQueryDto variableValuesIgnoreCase​(Boolean variableValuesIgnoreCase)
      • getVariableValuesIgnoreCase

        public Boolean getVariableValuesIgnoreCase()
        Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal.
        Returns:
        variableValuesIgnoreCase
      • setVariableValuesIgnoreCase

        public void setVariableValuesIgnoreCase​(Boolean variableValuesIgnoreCase)
      • getParentTaskId

        public String getParentTaskId()
        Restrict query to all tasks that are sub tasks of the given task. Takes a task id.
        Returns:
        parentTaskId
      • setParentTaskId

        public void setParentTaskId​(String parentTaskId)
      • getOrQueries

        public List<TaskQueryDto> getOrQueries()
        A JSON 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](https://en.wikipedia.org/wiki/Conjunctive_normal_form)). All task query properties can be used except for: `sorting`, `withCandidateGroups`, `withoutCandidateGroups`, `withCandidateUsers`, `withoutCandidateUsers` See the [User guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries.
        Returns:
        orQueries
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object