Package org.openapitools.client.model

Class HistoricVariableInstanceQueryDto

  • public class HistoricVariableInstanceQueryDto
extends Object
    A Historic Variable Instance instance query which defines a list of Historic Variable Instance instances

    • Constructor Detail

      • HistoricVariableInstanceQueryDto

        public HistoricVariableInstanceQueryDto()

    • Method Detail

      • getVariableName

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

      • setVariableName

        public void setVariableName​(String variableName)

      • getVariableNameLike

        public String getVariableNameLike()
        Restrict to variables with a name like the parameter.
        Returns:
        variableNameLike

      • setVariableNameLike

        public void setVariableNameLike​(String variableNameLike)

      • getVariableValue

        public Object getVariableValue()
        Filter by variable value. May be `String`, `Number` or `Boolean`.
        Returns:
        variableValue

      • setVariableValue

        public void setVariableValue​(Object variableValue)

      • getVariableNamesIgnoreCase

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

      • setVariableValuesIgnoreCase

        public void setVariableValuesIgnoreCase​(Boolean variableValuesIgnoreCase)

      • getVariableTypeIn

        public List<String> getVariableTypeIn()
        Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'.
        Returns:
        variableTypeIn

      • setVariableTypeIn

        public void setVariableTypeIn​(List<String> variableTypeIn)

      • getIncludeDeleted

        public Boolean getIncludeDeleted()
        Include variables that has already been deleted during the execution.
        Returns:
        includeDeleted

      • setIncludeDeleted

        public void setIncludeDeleted​(Boolean includeDeleted)

      • getProcessInstanceId

        public String getProcessInstanceId()
        Filter by the process instance the variable belongs to.
        Returns:
        processInstanceId

      • setProcessInstanceId

        public void setProcessInstanceId​(String processInstanceId)

      • getProcessInstanceIdIn

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

      • setProcessInstanceIdIn

        public void setProcessInstanceIdIn​(List<String> processInstanceIdIn)

      • getProcessDefinitionId

        public String getProcessDefinitionId()
        Filter by the process definition the variable belongs to.
        Returns:
        processDefinitionId

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getProcessDefinitionKey

        public String getProcessDefinitionKey()
        Filter by a key of the process definition the variable belongs to.
        Returns:
        processDefinitionKey

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)

      • getExecutionIdIn

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

      • setExecutionIdIn

        public void setExecutionIdIn​(List<String> executionIdIn)

      • getCaseInstanceId

        public String getCaseInstanceId()
        Filter by the case instance the variable belongs to.
        Returns:
        caseInstanceId

      • setCaseInstanceId

        public void setCaseInstanceId​(String caseInstanceId)

      • getCaseExecutionIdIn

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

      • setCaseExecutionIdIn

        public void setCaseExecutionIdIn​(List<String> caseExecutionIdIn)

      • getCaseActivityIdIn

        public List<String> getCaseActivityIdIn()
        Only include historic variable instances which belong to one of the passed and case activity ids.
        Returns:
        caseActivityIdIn

      • setCaseActivityIdIn

        public void setCaseActivityIdIn​(List<String> caseActivityIdIn)

      • getTaskIdIn

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

      • setTaskIdIn

        public void setTaskIdIn​(List<String> taskIdIn)

      • getActivityInstanceIdIn

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

      • setActivityInstanceIdIn

        public void setActivityInstanceIdIn​(List<String> activityInstanceIdIn)

      • getTenantIdIn

        public List<String> getTenantIdIn()
        Only include historic variable instances 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 historic variable 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)

      • getVariableNameIn

        public List<String> getVariableNameIn()
        Only include historic variable instances which belong to one of the passed variable names.
        Returns:
        variableNameIn

      • setVariableNameIn

        public void setVariableNameIn​(List<String> variableNameIn)

      • getSorting

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