VariableInstanceQuery (Camunda Platform Javadocs 7.15.19-ee)

All Superinterfaces:

Query<VariableInstanceQuery,VariableInstance>

All Known Implementing Classes:

VariableInstanceQueryImpl
```
public interface VariableInstanceQuery
extends Query<VariableInstanceQuery,VariableInstance>
```
Author:

roman.smirnov

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`VariableInstanceQuery`	`activityInstanceIdIn(String... activityInstanceIds)` Only select variable instances which have one of the activity instance ids.
`VariableInstanceQuery`	`batchIdIn(String... batchIds)` Only select variable instances which are related to one of the given batch ids.
`VariableInstanceQuery`	`caseExecutionIdIn(String... caseExecutionIds)` Only select variable instances which have one of the case execution ids.
`VariableInstanceQuery`	`caseInstanceIdIn(String... caseInstanceIds)` Only select variable instances which have one of the case instance ids.
`VariableInstanceQuery`	`disableBinaryFetching()` Disable fetching of byte array and file values.
`VariableInstanceQuery`	`disableCustomObjectDeserialization()` Disable deserialization of variable values that are custom objects.
`VariableInstanceQuery`	`executionIdIn(String... executionIds)` Only select variable instances which have one of the executions ids.
`VariableInstanceQuery`	`matchVariableNamesIgnoreCase()` The query will match the names of variables in a case-insensitive way. Note: This affects all `variableValueXXX` filters: `variableValueEquals(String, Object)` `variableValueGreaterThan(String, Object)` `variableValueGreaterThanOrEqual(String, Object)` `variableValueLessThan(String, Object)` `variableValueLessThanOrEqual(String, Object)` `variableValueLike(String, String)` `variableValueNotEquals(String, Object)` It does not affect: `variableName(String)` `variableNameIn(String...)` `variableNameLike(String)`
`VariableInstanceQuery`	`matchVariableValuesIgnoreCase()` The query will match the values of variables in a case-insensitive way. Note: This affects all `variableValueXXX` filters: `variableValueEquals(String, Object)` `variableValueGreaterThan(String, Object)` `variableValueGreaterThanOrEqual(String, Object)` `variableValueLessThan(String, Object)` `variableValueLessThanOrEqual(String, Object)` `variableValueLike(String, String)` `variableValueNotEquals(String, Object)`
`VariableInstanceQuery`	`orderByActivityInstanceId()` Order by activity instance id (needs to be followed by `Query.asc()` or `Query.desc()`).
`VariableInstanceQuery`	`orderByTenantId()` Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`VariableInstanceQuery`	`orderByVariableName()` Order by variable name (needs to be followed by `Query.asc()` or `Query.desc()`).
`VariableInstanceQuery`	`orderByVariableType()` Order by variable type (needs to be followed by `Query.asc()` or `Query.desc()`).
`VariableInstanceQuery`	`processInstanceIdIn(String... processInstanceIds)` Only select variable instances which have one of the process instance ids.
`VariableInstanceQuery`	`taskIdIn(String... taskIds)` Only select variable instances which have one of the task ids.
`VariableInstanceQuery`	`tenantIdIn(String... tenantIds)` Only select variable instances with one of the given tenant ids.
`VariableInstanceQuery`	`variableId(String id)` Only select the variable with the given Id
`VariableInstanceQuery`	`variableName(String variableName)` Only select variable instances which have the variable name.
`VariableInstanceQuery`	`variableNameIn(String... variableNames)` Only select variable instances which have one of the variables names.
`VariableInstanceQuery`	`variableNameLike(String variableNameLike)` Only select variable instances which have the name like the assigned variable name.
`VariableInstanceQuery`	`variableScopeIdIn(String... variableScopeIds)` Only select variables instances which have on of the variable scope ids.
`VariableInstanceQuery`	`variableValueEquals(String name, Object value)` Only select variables instances which have the given name and value.
`VariableInstanceQuery`	`variableValueGreaterThan(String name, Object value)` Only select variable instances which value is greater than the passed value.
`VariableInstanceQuery`	`variableValueGreaterThanOrEqual(String name, Object value)` Only select variable instances which value is greater than or equal to the passed value.
`VariableInstanceQuery`	`variableValueLessThan(String name, Object value)` Only select variable instances which value is less than the passed value.
`VariableInstanceQuery`	`variableValueLessThanOrEqual(String name, Object value)` Only select variable instances which value is less than or equal to the passed value.
`VariableInstanceQuery`	`variableValueLike(String name, String value)` Only select variable instances which value is like the given value.
`VariableInstanceQuery`	`variableValueNotEquals(String name, Object value)` Only select variable instances which have the given name, but with a different value than the passed value.

Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList

- Method Detail
  - variableId
```
VariableInstanceQuery variableId(String id)
```
    Only select the variable with the given Id
    
    Parameters:
    
    the - id of the variable to select
    
    Returns:
    
    the query object
  - variableName
```
VariableInstanceQuery variableName(String variableName)
```
    Only select variable instances which have the variable name.
  - variableNameIn
```
VariableInstanceQuery variableNameIn(String... variableNames)
```
    Only select variable instances which have one of the variables names.
  - variableNameLike
```
VariableInstanceQuery variableNameLike(String variableNameLike)
```
    Only select variable instances which have the name like the assigned variable name. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - executionIdIn
```
VariableInstanceQuery executionIdIn(String... executionIds)
```
    Only select variable instances which have one of the executions ids.
  - processInstanceIdIn
```
VariableInstanceQuery processInstanceIdIn(String... processInstanceIds)
```
    Only select variable instances which have one of the process instance ids.
  - caseExecutionIdIn
```
VariableInstanceQuery caseExecutionIdIn(String... caseExecutionIds)
```
    Only select variable instances which have one of the case execution ids.
  - caseInstanceIdIn
```
VariableInstanceQuery caseInstanceIdIn(String... caseInstanceIds)
```
    Only select variable instances which have one of the case instance ids.
  - taskIdIn
```
VariableInstanceQuery taskIdIn(String... taskIds)
```
    Only select variable instances which have one of the task ids.
  - batchIdIn
```
VariableInstanceQuery batchIdIn(String... batchIds)
```
    Only select variable instances which are related to one of the given batch ids.
  - variableScopeIdIn
```
VariableInstanceQuery variableScopeIdIn(String... variableScopeIds)
```
    Only select variables instances which have on of the variable scope ids.
  - activityInstanceIdIn
```
VariableInstanceQuery activityInstanceIdIn(String... activityInstanceIds)
```
    Only select variable instances which have one of the activity instance ids.
  - matchVariableNamesIgnoreCase
```
VariableInstanceQuery matchVariableNamesIgnoreCase()
```
    The query will match the names of variables in a case-insensitive way.
    Note: This affects all variableValueXXX filters:
    It does not affect:
  - matchVariableValuesIgnoreCase
```
VariableInstanceQuery matchVariableValuesIgnoreCase()
```
    The query will match the values of variables in a case-insensitive way.
    Note: This affects all variableValueXXX filters:
  - variableValueEquals
```
VariableInstanceQuery variableValueEquals(String name,
                                          Object value)
```
    Only select variables instances which have the given name and value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableSerializers(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    
    name - name of the variable, cannot be null.
    
    value - variable value, can be null.
  - variableValueNotEquals
```
VariableInstanceQuery variableValueNotEquals(String name,
                                             Object value)
```
    Only select variable instances which have the given name, but with a different value than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    
    name - name of the variable, cannot be null.
    
    value - variable value, can be null.
  - variableValueGreaterThan
```
VariableInstanceQuery variableValueGreaterThan(String name,
                                               Object value)
```
    Only select variable instances which value is greater than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null.
  - variableValueGreaterThanOrEqual
```
VariableInstanceQuery variableValueGreaterThanOrEqual(String name,
                                                      Object value)
```
    Only select variable instances which value is greater than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null.
  - variableValueLessThan
```
VariableInstanceQuery variableValueLessThan(String name,
                                            Object value)
```
    Only select variable instances which value is less than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null.
  - variableValueLessThanOrEqual
```
VariableInstanceQuery variableValueLessThanOrEqual(String name,
                                                   Object value)
```
    Only select variable instances which value is less than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null.
  - disableBinaryFetching
```
VariableInstanceQuery disableBinaryFetching()
```
    Disable fetching of byte array and file values. By default, the query will fetch such values. By calling this method you can prevent the values of (potentially large) blob data chunks to be fetched. The variables themselves are nonetheless included in the query result.
    
    Returns:
    
    the query builder
  - disableCustomObjectDeserialization
```
VariableInstanceQuery disableCustomObjectDeserialization()
```
    Disable deserialization of variable values that are custom objects. By default, the query will attempt to deserialize the value of these variables. By calling this method you can prevent such attempts in environments where their classes are not available. Independent of this setting, variable serialized values are accessible.
  - variableValueLike
```
VariableInstanceQuery variableValueLike(String name,
                                        String value)
```
    Only select variable instances which value is like the given value. This be used on string variables only.
    
    Parameters:
    
    name - variable name, cannot be null.
    
    value - variable value, cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
  - tenantIdIn
```
VariableInstanceQuery tenantIdIn(String... tenantIds)
```
    Only select variable instances with one of the given tenant ids.
  - orderByVariableName
```
VariableInstanceQuery orderByVariableName()
```
    Order by variable name (needs to be followed by Query.asc() or Query.desc()).
  - orderByVariableType
```
VariableInstanceQuery orderByVariableType()
```
    Order by variable type (needs to be followed by Query.asc() or Query.desc()).
  - orderByActivityInstanceId
```
VariableInstanceQuery orderByActivityInstanceId()
```
    Order by activity instance id (needs to be followed by Query.asc() or Query.desc()).
  - orderByTenantId
```
VariableInstanceQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of variable instances without tenant id is database-specific.

Interface VariableInstanceQuery

Method Summary

Methods inherited from interface org.camunda.bpm.engine.query.Query

Method Detail

variableId

variableName

variableNameIn

variableNameLike

executionIdIn

processInstanceIdIn

caseExecutionIdIn

caseInstanceIdIn

taskIdIn

batchIdIn

variableScopeIdIn

activityInstanceIdIn

matchVariableNamesIgnoreCase

matchVariableValuesIgnoreCase

variableValueEquals

variableValueNotEquals

variableValueGreaterThan

variableValueGreaterThanOrEqual

variableValueLessThan

variableValueLessThanOrEqual

disableBinaryFetching

disableCustomObjectDeserialization

variableValueLike

tenantIdIn

orderByVariableName

orderByVariableType

orderByActivityInstanceId

orderByTenantId