Class HistoricTaskInstanceQueryDto


  • public class HistoricTaskInstanceQueryDto
    extends Object
    A Historic Task instance query which defines a list of Historic Task instances
    • Constructor Detail

      • HistoricTaskInstanceQueryDto

        public HistoricTaskInstanceQueryDto()
    • Method Detail

      • getTaskId

        public String getTaskId()
        Filter by task id.
        Returns:
        taskId
      • setTaskId

        public void setTaskId​(String taskId)
      • getTaskParentTaskId

        public String getTaskParentTaskId()
        Filter by parent task id.
        Returns:
        taskParentTaskId
      • setTaskParentTaskId

        public void setTaskParentTaskId​(String taskParentTaskId)
      • getProcessInstanceId

        public String getProcessInstanceId()
        Filter by process instance id.
        Returns:
        processInstanceId
      • setProcessInstanceId

        public void setProcessInstanceId​(String processInstanceId)
      • getProcessInstanceBusinessKey

        public String getProcessInstanceBusinessKey()
        Filter by process instance business key.
        Returns:
        processInstanceBusinessKey
      • setProcessInstanceBusinessKey

        public void setProcessInstanceBusinessKey​(String processInstanceBusinessKey)
      • getProcessInstanceBusinessKeyIn

        public List<String> getProcessInstanceBusinessKeyIn()
        Filter by 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)
      • getProcessInstanceBusinessKeyLike

        public String getProcessInstanceBusinessKeyLike()
        Filter by process instance business key that has the parameter value as a substring.
        Returns:
        processInstanceBusinessKeyLike
      • setProcessInstanceBusinessKeyLike

        public void setProcessInstanceBusinessKeyLike​(String processInstanceBusinessKeyLike)
      • getExecutionId

        public String getExecutionId()
        Filter by the id of the execution that executed the task.
        Returns:
        executionId
      • setExecutionId

        public void setExecutionId​(String executionId)
      • getProcessDefinitionId

        public String getProcessDefinitionId()
        Filter by process definition id.
        Returns:
        processDefinitionId
      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)
      • 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)
      • 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)
      • getCaseInstanceId

        public String getCaseInstanceId()
        Filter by case instance id.
        Returns:
        caseInstanceId
      • setCaseInstanceId

        public void setCaseInstanceId​(String caseInstanceId)
      • getCaseExecutionId

        public String getCaseExecutionId()
        Filter by the id of the case execution that executed the task.
        Returns:
        caseExecutionId
      • setCaseExecutionId

        public void setCaseExecutionId​(String caseExecutionId)
      • getCaseDefinitionId

        public String getCaseDefinitionId()
        Filter by case definition 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)
      • 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)
      • getActivityInstanceIdIn

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

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

        public String getTaskName()
        Restrict to tasks that have the given name.
        Returns:
        taskName
      • setTaskName

        public void setTaskName​(String taskName)
      • getTaskNameLike

        public String getTaskNameLike()
        Restrict to tasks that have a name with the given parameter value as substring.
        Returns:
        taskNameLike
      • setTaskNameLike

        public void setTaskNameLike​(String taskNameLike)
      • getTaskDescription

        public String getTaskDescription()
        Restrict to tasks that have the given description.
        Returns:
        taskDescription
      • setTaskDescription

        public void setTaskDescription​(String taskDescription)
      • getTaskDescriptionLike

        public String getTaskDescriptionLike()
        Restrict to tasks that have a description that has the parameter value as a substring.
        Returns:
        taskDescriptionLike
      • setTaskDescriptionLike

        public void setTaskDescriptionLike​(String taskDescriptionLike)
      • getTaskDefinitionKey

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

        public void setTaskDefinitionKey​(String taskDefinitionKey)
      • getTaskDefinitionKeyIn

        public List<String> getTaskDefinitionKeyIn()
        Restrict to tasks that have one of the passed task definition keys.
        Returns:
        taskDefinitionKeyIn
      • setTaskDefinitionKeyIn

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

        public String getTaskDeleteReason()
        Restrict to tasks that have the given delete reason.
        Returns:
        taskDeleteReason
      • setTaskDeleteReason

        public void setTaskDeleteReason​(String taskDeleteReason)
      • getTaskDeleteReasonLike

        public String getTaskDeleteReasonLike()
        Restrict to tasks that have a delete reason that has the parameter value as a substring.
        Returns:
        taskDeleteReasonLike
      • setTaskDeleteReasonLike

        public void setTaskDeleteReasonLike​(String taskDeleteReasonLike)
      • getTaskAssignee

        public String getTaskAssignee()
        Restrict to tasks that the given user is assigned to.
        Returns:
        taskAssignee
      • setTaskAssignee

        public void setTaskAssignee​(String taskAssignee)
      • getTaskAssigneeLike

        public String getTaskAssigneeLike()
        Restrict to tasks that are assigned to users with the parameter value as a substring.
        Returns:
        taskAssigneeLike
      • setTaskAssigneeLike

        public void setTaskAssigneeLike​(String taskAssigneeLike)
      • getTaskOwner

        public String getTaskOwner()
        Restrict to tasks that the given user owns.
        Returns:
        taskOwner
      • setTaskOwner

        public void setTaskOwner​(String taskOwner)
      • getTaskOwnerLike

        public String getTaskOwnerLike()
        Restrict to tasks that are owned by users with the parameter value as a substring.
        Returns:
        taskOwnerLike
      • setTaskOwnerLike

        public void setTaskOwnerLike​(String taskOwnerLike)
      • getTaskPriority

        public Integer getTaskPriority()
        Restrict to tasks that have the given priority.
        Returns:
        taskPriority
      • setTaskPriority

        public void setTaskPriority​(Integer taskPriority)
      • 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)
      • getFinished

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

        public void setFinished​(Boolean finished)
      • getUnfinished

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

        public void setUnfinished​(Boolean unfinished)
      • getProcessFinished

        public Boolean getProcessFinished()
        Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior.
        Returns:
        processFinished
      • setProcessFinished

        public void setProcessFinished​(Boolean processFinished)
      • getProcessUnfinished

        public Boolean getProcessUnfinished()
        Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior.
        Returns:
        processUnfinished
      • setProcessUnfinished

        public void setProcessUnfinished​(Boolean processUnfinished)
      • getTaskDueDate

        public Date getTaskDueDate()
        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.000+0200`.
        Returns:
        taskDueDate
      • setTaskDueDate

        public void setTaskDueDate​(Date taskDueDate)
      • getTaskDueDateBefore

        public Date getTaskDueDateBefore()
        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.000+0200`.
        Returns:
        taskDueDateBefore
      • setTaskDueDateBefore

        public void setTaskDueDateBefore​(Date taskDueDateBefore)
      • getTaskDueDateAfter

        public Date getTaskDueDateAfter()
        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.000+0200`.
        Returns:
        taskDueDateAfter
      • setTaskDueDateAfter

        public void setTaskDueDateAfter​(Date taskDueDateAfter)
      • getWithoutTaskDueDate

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

        public void setWithoutTaskDueDate​(Boolean withoutTaskDueDate)
      • getTaskFollowUpDate

        public Date getTaskFollowUpDate()
        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.000+0200`.
        Returns:
        taskFollowUpDate
      • setTaskFollowUpDate

        public void setTaskFollowUpDate​(Date taskFollowUpDate)
      • getTaskFollowUpDateBefore

        public Date getTaskFollowUpDateBefore()
        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.000+0200`.
        Returns:
        taskFollowUpDateBefore
      • setTaskFollowUpDateBefore

        public void setTaskFollowUpDateBefore​(Date taskFollowUpDateBefore)
      • getTaskFollowUpDateAfter

        public Date getTaskFollowUpDateAfter()
        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.000+0200`.
        Returns:
        taskFollowUpDateAfter
      • setTaskFollowUpDateAfter

        public void setTaskFollowUpDateAfter​(Date taskFollowUpDateAfter)
      • getStartedBefore

        public Date getStartedBefore()
        Restrict to tasks that were started 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.000+0200`.
        Returns:
        startedBefore
      • setStartedBefore

        public void setStartedBefore​(Date startedBefore)
      • getStartedAfter

        public Date getStartedAfter()
        Restrict to tasks that were started 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.000+0200`.
        Returns:
        startedAfter
      • setStartedAfter

        public void setStartedAfter​(Date startedAfter)
      • getFinishedBefore

        public Date getFinishedBefore()
        Restrict to tasks that were finished 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.000+0200`.
        Returns:
        finishedBefore
      • setFinishedBefore

        public void setFinishedBefore​(Date finishedBefore)
      • getFinishedAfter

        public Date getFinishedAfter()
        Restrict to tasks that were finished 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.000+0200`.
        Returns:
        finishedAfter
      • setFinishedAfter

        public void setFinishedAfter​(Date finishedAfter)
      • getTenantIdIn

        public List<String> getTenantIdIn()
        Filter by a list of tenant ids. A task instance must have one of the given tenant ids.
        Returns:
        tenantIdIn
      • setTenantIdIn

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

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

        public void setWithoutTenantId​(Boolean withoutTenantId)
      • getTaskVariables

        public List<VariableQueryParameterDto> getTaskVariables()
        Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. 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()
        Only include tasks that belong to process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. 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
      • getVariableNamesIgnoreCase

        public Boolean getVariableNamesIgnoreCase()
        Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal.
        Returns:
        variableNamesIgnoreCase
      • setVariableNamesIgnoreCase

        public void setVariableNamesIgnoreCase​(Boolean variableNamesIgnoreCase)
      • getVariableValuesIgnoreCase

        public Boolean getVariableValuesIgnoreCase()
        Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal.
        Returns:
        variableValuesIgnoreCase
      • setVariableValuesIgnoreCase

        public void setVariableValuesIgnoreCase​(Boolean variableValuesIgnoreCase)
      • getTaskInvolvedUser

        public String getTaskInvolvedUser()
        Restrict to tasks with a historic identity link to the given user.
        Returns:
        taskInvolvedUser
      • setTaskInvolvedUser

        public void setTaskInvolvedUser​(String taskInvolvedUser)
      • getTaskInvolvedGroup

        public String getTaskInvolvedGroup()
        Restrict to tasks with a historic identity link to the given group.
        Returns:
        taskInvolvedGroup
      • setTaskInvolvedGroup

        public void setTaskInvolvedGroup​(String taskInvolvedGroup)
      • getTaskHadCandidateUser

        public String getTaskHadCandidateUser()
        Restrict to tasks with a historic identity link to the given candidate user.
        Returns:
        taskHadCandidateUser
      • setTaskHadCandidateUser

        public void setTaskHadCandidateUser​(String taskHadCandidateUser)
      • getTaskHadCandidateGroup

        public String getTaskHadCandidateGroup()
        Restrict to tasks with a historic identity link to the given candidate group.
        Returns:
        taskHadCandidateGroup
      • setTaskHadCandidateGroup

        public void setTaskHadCandidateGroup​(String taskHadCandidateGroup)
      • 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)
      • 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)
      • getOrQueries

        public List<HistoricTaskInstanceQueryDto> getOrQueries()
        A JSON array of nested historic task instance queries with OR semantics. A task instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a task instance must fulfill at least one predicate of each query ([Conjunctive Normal Form](https://en.wikipedia.org/wiki/Conjunctive_normal_form)). All task instance query properties can be used except for: `sorting`, `withCandidateGroups`, ` withoutCandidateGroups`. 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
      • getSorting

        public List<HistoricTaskInstanceQueryDtoSorting> getSorting()
        An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Sorting has no effect for `count` endpoints
        Returns:
        sorting
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object