Package org.openapitools.client.model

Class ProcessInstanceQueryDto

  • public class ProcessInstanceQueryDto
extends Object
    A process instance query which defines a group of process instances

    • Constructor Detail

      • ProcessInstanceQueryDto

        public ProcessInstanceQueryDto()

    • Method Detail

      • getDeploymentId

        public String getDeploymentId()
        Filter by the deployment the id belongs to.
        Returns:
        deploymentId

      • setDeploymentId

        public void setDeploymentId​(String deploymentId)

      • getProcessDefinitionId

        public String getProcessDefinitionId()
        Filter by the process definition the instances run on.
        Returns:
        processDefinitionId

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getProcessDefinitionKey

        public String getProcessDefinitionKey()
        Filter by the key of the process definition the instances run on.
        Returns:
        processDefinitionKey

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)

      • getProcessDefinitionKeyIn

        public List<String> getProcessDefinitionKeyIn()
        Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of Strings.
        Returns:
        processDefinitionKeyIn

      • setProcessDefinitionKeyIn

        public void setProcessDefinitionKeyIn​(List<String> processDefinitionKeyIn)

      • getProcessDefinitionKeyNotIn

        public List<String> getProcessDefinitionKeyNotIn()
        Exclude instances by a list of process definition keys. A process instance must not have one of the given process definition keys. Must be a JSON array of Strings.
        Returns:
        processDefinitionKeyNotIn

      • setProcessDefinitionKeyNotIn

        public void setProcessDefinitionKeyNotIn​(List<String> processDefinitionKeyNotIn)

      • getBusinessKey

        public String getBusinessKey()
        Filter by process instance business key.
        Returns:
        businessKey

      • setBusinessKey

        public void setBusinessKey​(String businessKey)

      • getBusinessKeyLike

        public String getBusinessKeyLike()
        Filter by process instance business key that the parameter is a substring of.
        Returns:
        businessKeyLike

      • setBusinessKeyLike

        public void setBusinessKeyLike​(String businessKeyLike)

      • getCaseInstanceId

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

      • setCaseInstanceId

        public void setCaseInstanceId​(String caseInstanceId)

      • getSuperProcessInstance

        public String getSuperProcessInstance()
        Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.
        Returns:
        superProcessInstance

      • setSuperProcessInstance

        public void setSuperProcessInstance​(String superProcessInstance)

      • getSubProcessInstance

        public String getSubProcessInstance()
        Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id.
        Returns:
        subProcessInstance

      • setSubProcessInstance

        public void setSubProcessInstance​(String subProcessInstance)

      • getSuperCaseInstance

        public String getSuperCaseInstance()
        Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
        Returns:
        superCaseInstance

      • setSuperCaseInstance

        public void setSuperCaseInstance​(String superCaseInstance)

      • getSubCaseInstance

        public String getSubCaseInstance()
        Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id.
        Returns:
        subCaseInstance

      • setSubCaseInstance

        public void setSubCaseInstance​(String subCaseInstance)

      • getActive

        public Boolean getActive()
        Only include active process instances. 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 process instances. Value may only be true, as false is the default behavior.
        Returns:
        suspended

      • setSuspended

        public void setSuspended​(Boolean suspended)

      • getProcessInstanceIds

        public List<String> getProcessInstanceIds()
        Filter by a list of process instance ids. Must be a JSON array of Strings.
        Returns:
        processInstanceIds

      • setProcessInstanceIds

        public void setProcessInstanceIds​(List<String> processInstanceIds)

      • getWithIncident

        public Boolean getWithIncident()
        Filter by presence of incidents. Selects only process instances that have an incident.
        Returns:
        withIncident

      • setWithIncident

        public void setWithIncident​(Boolean withIncident)

      • getIncidentId

        public String getIncidentId()
        Filter by the incident id.
        Returns:
        incidentId

      • setIncidentId

        public void setIncidentId​(String incidentId)

      • getIncidentType

        public String getIncidentType()
        Filter by the incident type. See the User Guide for a list of incident types.
        Returns:
        incidentType

      • setIncidentType

        public void setIncidentType​(String incidentType)

      • getIncidentMessage

        public String getIncidentMessage()
        Filter by the incident message. Exact match.
        Returns:
        incidentMessage

      • setIncidentMessage

        public void setIncidentMessage​(String incidentMessage)

      • getIncidentMessageLike

        public String getIncidentMessageLike()
        Filter by the incident message that the parameter is a substring of.
        Returns:
        incidentMessageLike

      • setIncidentMessageLike

        public void setIncidentMessageLike​(String incidentMessageLike)

      • getTenantIdIn

        public List<String> getTenantIdIn()
        Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of Strings.
        Returns:
        tenantIdIn

      • setTenantIdIn

        public void setTenantIdIn​(List<String> tenantIdIn)

      • getWithoutTenantId

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

      • setWithoutTenantId

        public void setWithoutTenantId​(Boolean withoutTenantId)

      • getProcessDefinitionWithoutTenantId

        public Boolean getProcessDefinitionWithoutTenantId()
        Only include process instances which process definition has no tenant id.
        Returns:
        processDefinitionWithoutTenantId

      • setProcessDefinitionWithoutTenantId

        public void setProcessDefinitionWithoutTenantId​(Boolean processDefinitionWithoutTenantId)

      • getActivityIdIn

        public List<String> getActivityIdIn()
        Filter by a list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids.
        Returns:
        activityIdIn

      • setActivityIdIn

        public void setActivityIdIn​(List<String> activityIdIn)

      • getRootProcessInstances

        public Boolean getRootProcessInstances()
        Restrict the query to all process instances that are top level process instances.
        Returns:
        rootProcessInstances

      • setRootProcessInstances

        public void setRootProcessInstances​(Boolean rootProcessInstances)

      • getLeafProcessInstances

        public Boolean getLeafProcessInstances()
        Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances)
        Returns:
        leafProcessInstances

      • setLeafProcessInstances

        public void setLeafProcessInstances​(Boolean leafProcessInstances)

      • getVariables

        public List<VariableQueryParameterDto> getVariables()
        A JSON array to only include process instances that have variables with certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name` (String) is the variable name, `operator` (String) is the comparison operator to be used and `value` the variable value. The `value` may be 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`.
        Returns:
        variables

      • getVariableNamesIgnoreCase

        public Boolean getVariableNamesIgnoreCase()
        Match all variable names in this query 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 all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal.
        Returns:
        variableValuesIgnoreCase

      • setVariableValuesIgnoreCase

        public void setVariableValuesIgnoreCase​(Boolean variableValuesIgnoreCase)

      • getOrQueries

        public List<ProcessInstanceQueryDto> getOrQueries()
        A JSON array of nested process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query (Conjunctive Normal Form). All process instance query properties can be used except for: `sorting` 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