Package com.priint.pubserver.bpm.model

Class TaskQueryDto

  • public class TaskQueryDto
extends java.lang.Object
    A Object which is send to BPM to get list of CustomTask

    • Constructor Detail

      • TaskQueryDto

        public TaskQueryDto​(java.lang.String taskId,
                    java.util.List<java.lang.String> taskIds,
                    java.lang.String processInstanceId,
                    java.util.List<java.lang.String> processInstanceIdIn,
                    java.lang.String processInstanceBusinessKey,
                    java.util.List<java.lang.String> processInstanceBusinessKeyIn,
                    java.lang.String processInstanceBusinessKeyLike,
                    java.lang.String processDefinitionId,
                    java.lang.String processDefinitionKey,
                    java.util.List<java.lang.String> processDefinitionKeyIn,
                    java.lang.String processDefinitionName,
                    java.lang.String processDefinitionNameLike,
                    java.lang.String executionId,
                    java.util.List<java.lang.String> activityInstanceIdIn,
                    java.lang.String tenantId,
                    java.util.List<java.lang.String> tenantIdIn,
                    java.lang.Boolean withoutTenantId,
                    java.lang.String assignee,
                    java.lang.String assigneeExpression,
                    java.lang.String assigneeLike,
                    java.util.List<java.lang.String> assigneeIn,
                    java.lang.String owner,
                    java.lang.String candidateGroup,
                    java.util.List<java.lang.String> candidateGroups,
                    java.lang.Boolean withCandidateGroups,
                    java.lang.Boolean withoutCandidateGroups,
                    java.lang.Boolean withCandidateUsers,
                    java.lang.Boolean withoutCandidateUsers,
                    java.lang.String candidateUser,
                    java.lang.Boolean includeAssignedTasks,
                    java.lang.Boolean assigned,
                    java.lang.Boolean unassigned,
                    java.lang.String taskDefinitionKey,
                    java.util.List<java.lang.String> taskDefinitionKeyIn,
                    java.lang.String taskDefinitionKeyLike,
                    java.lang.String name,
                    java.lang.String nameLike,
                    java.util.Date dueDate,
                    java.util.Date dueAfter,
                    java.util.Date dueBefore,
                    java.util.Date createdAfter,
                    java.lang.String delegationState,
                    java.util.List<VariableQueryDto> processVariables,
                    java.util.List<TaskQueryDto> orQueries,
                    java.util.List<BpmQuerySorting> sorting)
        A Object which is send to BPM to get list of CustomTask

      • TaskQueryDto

        public TaskQueryDto()
        A Object which is send to BPM to get list of CustomTask

    • Method Detail

      • addProcessVariable

        public void addProcessVariable​(ProcessVariableOperator operator,
                               java.lang.String name,
                               java.lang.String value)
        adds new entry to

      • getTaskId

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

      • getTaskIds

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

      • getProcessInstanceId

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

      • getProcessInstanceIdIn

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

      • getProcessInstanceBusinessKey

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

      • getProcessInstanceBusinessKeyIn

        public java.util.List<java.lang.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 java.lang.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 java.lang.String getProcessDefinitionId()
        Returns:
        String which Restrict to tasks that belong to a process definition with the given id.

      • getProcessDefinitionKey

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

      • getProcessDefinitionKeyIn

        public java.util.List<java.lang.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 java.lang.String getProcessDefinitionName()
        Returns:
        String which Restrict to tasks that belong to a process definition with the given name.

      • getProcessDefinitionNameLike

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

      • getExecutionId

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

      • getActivityInstanceIdIn

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

      • getTenantId

        public java.lang.String getTenantId()
        Returns:
        the tenant id for the task String

      • getTenantIdIn

        public java.util.List<java.lang.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 java.lang.Boolean getWithoutTenantId()
        Returns:
        Boolean which only include tasks which belong to no tenant.

      • getAssignee

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

      • getAssigneeExpression

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

      • getAssigneeLike

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

      • getAssigneeIn

        public java.util.List<java.lang.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 java.lang.String getOwner()
        Returns:
        String which Restrict to tasks that the given user owns.

      • getCandidateGroup

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

      • getCandidateGroups

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

      • getWithCandidateGroups

        public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String getCandidateUser()
        Returns:
        String which only include tasks that are offered to the given user or to one of his groups.

      • getIncludeAssignedTasks

        public java.lang.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 java.lang.Boolean getAssigned()
        Returns:
        Boolean If set to true, restricts the query to all tasks that are assigned.

      • getUnassigned

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

      • getTaskDefinitionKey

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

      • getTaskDefinitionKeyIn

        public java.util.List<java.lang.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 java.lang.String getTaskDefinitionKeyLike()
        Returns:
        String which Restrict to tasks that have a key that has the parameter value as a substring.

      • getName

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

      • getNameLike

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

      • getDueDate

        public java.util.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 java.util.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 java.util.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 java.util.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 java.lang.String getDelegationState()
        Returns:
        String which Restrict to tasks that are in the given delegation state. Valid values are PENDING and RESOLVED.

      • getProcessVariables

        public java.util.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 java.util.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 java.util.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​(java.lang.String taskId)
        Parameters:
        taskId - String - Restrict to task with the given id.

      • setTaskIds

        public void setTaskIds​(java.util.List<java.lang.String> taskIds)
        Parameters:
        taskIds - List of String - Restrict to tasks with any of the given ids.

      • setProcessInstanceId

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

      • setProcessInstanceIdIn

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

      • setProcessInstanceBusinessKey

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

      • setProcessInstanceBusinessKeyIn

        public void setProcessInstanceBusinessKeyIn​(java.util.List<java.lang.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​(java.lang.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​(java.lang.String processDefinitionId)
        Parameters:
        processDefinitionId - String - Restrict to tasks that belong to a process definition with the given id.

      • setProcessDefinitionKey

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

      • setProcessDefinitionKeyIn

        public void setProcessDefinitionKeyIn​(java.util.List<java.lang.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​(java.lang.String processDefinitionName)
        Parameters:
        processDefinitionName - String - Restrict to tasks that belong to a process definition with the given name.

      • setProcessDefinitionNameLike

        public void setProcessDefinitionNameLike​(java.lang.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​(java.lang.String executionId)
        Parameters:
        executionId - String - Restrict to tasks that belong to an execution with the given id.

      • setActivityInstanceIdIn

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

      • setTenantId

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

      • setTenantIdIn

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

      • setWithoutTenantId

        public void setWithoutTenantId​(java.lang.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​(java.lang.String assignee)
        Parameters:
        assignee - String - Restrict to tasks that the given user is assigned to.

      • setAssigneeExpression

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

      • setAssigneeLike

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

      • setAssigneeIn

        public void setAssigneeIn​(java.util.List<java.lang.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​(java.lang.String owner)
        Parameters:
        owner - String - Restrict to tasks that the given user owns.

      • setCandidateGroup

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

      • setCandidateGroups

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

      • setWithCandidateGroups

        public void setWithCandidateGroups​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.Boolean assigned)
        Parameters:
        assigned - Boolean - If set to true, restricts the query to all tasks that are assigned.

      • setUnassigned

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

      • setTaskDefinitionKey

        public void setTaskDefinitionKey​(java.lang.String taskDefinitionKey)
        Parameters:
        taskDefinitionKey - String - Restrict to tasks that have the given key.

      • setTaskDefinitionKeyIn

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

      • setTaskDefinitionKeyLike

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

      • setName

        public void setName​(java.lang.String name)
        Parameters:
        name - String - Restrict to tasks that have the given name.

      • setNameLike

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

      • setDueDate

        public void setDueDate​(java.util.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​(java.util.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​(java.util.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​(java.util.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​(java.lang.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​(java.util.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​(java.util.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​(java.util.List<BpmQuerySorting> sorting)
        Parameters:
        sorting - List of TaskQueryDto - array of criteria to sort the result by.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object