Class VariableInstanceQueryDto


  • public class VariableInstanceQueryDto
    extends Object
    A variable instance query which defines a list of variable instances
    • Constructor Detail

      • VariableInstanceQueryDto

        public VariableInstanceQueryDto()
    • Method Detail

      • getVariableName

        public String getVariableName()
        Filter by variable instance name.
        Returns:
        variableName
      • setVariableName

        public void setVariableName​(String variableName)
      • getVariableNameLike

        public String getVariableNameLike()
        Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`).
        Returns:
        variableNameLike
      • setVariableNameLike

        public void setVariableNameLike​(String variableNameLike)
      • getProcessInstanceIdIn

        public List<String> getProcessInstanceIdIn()
        Only include variable instances which belong to one of the passed process instance ids.
        Returns:
        processInstanceIdIn
      • setProcessInstanceIdIn

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

        public List<String> getExecutionIdIn()
        Only include variable instances which belong to one of the passed execution ids.
        Returns:
        executionIdIn
      • setExecutionIdIn

        public void setExecutionIdIn​(List<String> executionIdIn)
      • getCaseInstanceIdIn

        public List<String> getCaseInstanceIdIn()
        Only include variable instances which belong to one of the passed case instance ids.
        Returns:
        caseInstanceIdIn
      • setCaseInstanceIdIn

        public void setCaseInstanceIdIn​(List<String> caseInstanceIdIn)
      • getCaseExecutionIdIn

        public List<String> getCaseExecutionIdIn()
        Only include variable instances which belong to one of the passed case execution ids.
        Returns:
        caseExecutionIdIn
      • setCaseExecutionIdIn

        public void setCaseExecutionIdIn​(List<String> caseExecutionIdIn)
      • getTaskIdIn

        public List<String> getTaskIdIn()
        Only include variable instances which belong to one of the passed task ids.
        Returns:
        taskIdIn
      • setTaskIdIn

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

        public List<String> getBatchIdIn()
        Only include variable instances which belong to one of the passed batch ids.
        Returns:
        batchIdIn
      • setBatchIdIn

        public void setBatchIdIn​(List<String> batchIdIn)
      • getActivityInstanceIdIn

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

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

        public List<String> getTenantIdIn()
        Only include variable instances which belong to one of the passed tenant ids.
        Returns:
        tenantIdIn
      • setTenantIdIn

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

        public List<VariableQueryParameterDto> getVariableValues()
        An array to only include variable instances that have the 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. `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:
        variableValues
      • getVariableNamesIgnoreCase

        public Boolean getVariableNamesIgnoreCase()
        Match all variable names provided in `variableValues` 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 provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal.
        Returns:
        variableValuesIgnoreCase
      • setVariableValuesIgnoreCase

        public void setVariableValuesIgnoreCase​(Boolean variableValuesIgnoreCase)
      • getVariableScopeIdIn

        public List<String> getVariableScopeIdIn()
        Only include variable instances which belong to one of passed scope ids.
        Returns:
        variableScopeIdIn
      • setVariableScopeIdIn

        public void setVariableScopeIdIn​(List<String> variableScopeIdIn)
      • getSorting

        public List<VariableInstanceQueryDtoSorting> 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