java.lang.Object
- org.camunda.bpm.engine.impl.db.ListQueryParameterObject
- - org.camunda.bpm.engine.impl.AbstractQuery<T,U>
  - - org.camunda.bpm.engine.impl.AbstractVariableQueryImpl<VariableInstanceQuery,VariableInstance>
    - - org.camunda.bpm.engine.impl.VariableInstanceQueryImpl

All Implemented Interfaces:

Serializable, Command<Object>, Query<VariableInstanceQuery,VariableInstance>, VariableInstanceQuery
```
public class VariableInstanceQueryImpl
extends AbstractVariableQueryImpl<VariableInstanceQuery,VariableInstance>
implements VariableInstanceQuery, Serializable
```
Author:

roman.smirnov

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery
  AbstractQuery.ResultType

Field Summary

Fields
Modifier and Type	Field	Description
`protected String[]`	`activityInstanceIds`
`protected String[]`	`batchIds`
`protected String[]`	`caseExecutionIds`
`protected String[]`	`caseInstanceIds`
`protected String[]`	`executionIds`
`protected boolean`	`isByteArrayFetchingEnabled`
`protected boolean`	`isCustomObjectDeserializationEnabled`
`protected String[]`	`processInstanceIds`
`protected String[]`	`taskIds`
`protected String[]`	`tenantIds`
`protected String`	`variableId`
`protected String`	`variableName`
`protected String`	`variableNameLike`
`protected String[]`	`variableNames`
`protected String[]`	`variableScopeIds`

Fields inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl
queryVariableValues, variableNamesIgnoreCase, variableValuesIgnoreCase

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery
commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject
authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors
Constructor Description

VariableInstanceQueryImpl()

VariableInstanceQueryImpl(CommandExecutor commandExecutor)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`long`	`executeCount(CommandContext commandContext)`
`List<VariableInstance>`	`executeList(CommandContext commandContext, Page page)`	Executes the actual query to retrieve the list of results.
`VariableInstanceQuery`	`executionIdIn(String... executionIds)`	Only select variable instances which have one of the executions ids.
`String[]`	`getActivityInstanceIds()`
`String[]`	`getBatchIds()`
`String[]`	`getCaseExecutionIds()`
`String[]`	`getCaseInstanceIds()`
`String[]`	`getExecutionIds()`
`String[]`	`getProcessInstanceIds()`
`String[]`	`getTaskIds()`
`String`	`getVariableId()`
`String`	`getVariableName()`
`String`	`getVariableNameLike()`
`String[]`	`getVariableNames()`
`String[]`	`getVariableScopeIds()`
`protected boolean`	`hasExcludingConditions()`	Whether or not the query has excluding conditions.
`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.
`protected boolean`	`shouldFetchValue(VariableInstanceEntity entity)`
`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.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl
addVariable, createQueryVariableValue, ensureVariablesInitialized, getQueryVariableValues, isVariableNamesIgnoreCase, isVariableValuesIgnoreCase, matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, validateVariable, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals, variableValueNotLike

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject
getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.camunda.bpm.engine.impl.interceptor.Command
isRetryable

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

Methods inherited from interface org.camunda.bpm.engine.runtime.VariableInstanceQuery
matchVariableNamesIgnoreCase, matchVariableValuesIgnoreCase, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals

- Field Detail
  - variableId
```
protected String variableId
```
  - variableName
```
protected String variableName
```
  - variableNames
```
protected String[] variableNames
```
  - variableNameLike
```
protected String variableNameLike
```
  - executionIds
```
protected String[] executionIds
```
  - processInstanceIds
```
protected String[] processInstanceIds
```
  - caseExecutionIds
```
protected String[] caseExecutionIds
```
  - caseInstanceIds
```
protected String[] caseInstanceIds
```
  - taskIds
```
protected String[] taskIds
```
  - batchIds
```
protected String[] batchIds
```
  - variableScopeIds
```
protected String[] variableScopeIds
```
  - activityInstanceIds
```
protected String[] activityInstanceIds
```
  - tenantIds
```
protected String[] tenantIds
```
  - isByteArrayFetchingEnabled
```
protected boolean isByteArrayFetchingEnabled
```
  - isCustomObjectDeserializationEnabled
```
protected boolean isCustomObjectDeserializationEnabled
```
- Constructor Detail
  - VariableInstanceQueryImpl
```
public VariableInstanceQueryImpl()
```
  - VariableInstanceQueryImpl
```
public VariableInstanceQueryImpl(CommandExecutor commandExecutor)
```
- Method Detail
  - variableId
```
public VariableInstanceQuery variableId(String id)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select the variable with the given Id
    
    Specified by:
    
    variableId in interface VariableInstanceQuery
    
    Returns:
    
    the query object
  - variableName
```
public VariableInstanceQuery variableName(String variableName)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which have the variable name.
    
    Specified by:
    
    variableName in interface VariableInstanceQuery
  - variableNameIn
```
public VariableInstanceQuery variableNameIn(String... variableNames)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which have one of the variables names.
    
    Specified by:
    
    variableNameIn in interface VariableInstanceQuery
  - variableNameLike
```
public VariableInstanceQuery variableNameLike(String variableNameLike)
```
    Description copied from interface: VariableInstanceQuery
    
    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%).
    
    Specified by:
    
    variableNameLike in interface VariableInstanceQuery
  - executionIdIn
```
public VariableInstanceQuery executionIdIn(String... executionIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which have one of the executions ids.
    
    Specified by:
    
    executionIdIn in interface VariableInstanceQuery
  - processInstanceIdIn
```
public VariableInstanceQuery processInstanceIdIn(String... processInstanceIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which have one of the process instance ids.
    
    Specified by:
    
    processInstanceIdIn in interface VariableInstanceQuery
  - caseExecutionIdIn
```
public VariableInstanceQuery caseExecutionIdIn(String... caseExecutionIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which have one of the case execution ids.
    
    Specified by:
    
    caseExecutionIdIn in interface VariableInstanceQuery
  - caseInstanceIdIn
```
public VariableInstanceQuery caseInstanceIdIn(String... caseInstanceIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which have one of the case instance ids.
    
    Specified by:
    
    caseInstanceIdIn in interface VariableInstanceQuery
  - taskIdIn
```
public VariableInstanceQuery taskIdIn(String... taskIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which have one of the task ids.
    
    Specified by:
    
    taskIdIn in interface VariableInstanceQuery
  - batchIdIn
```
public VariableInstanceQuery batchIdIn(String... batchIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which are related to one of the given batch ids.
    
    Specified by:
    
    batchIdIn in interface VariableInstanceQuery
  - variableScopeIdIn
```
public VariableInstanceQuery variableScopeIdIn(String... variableScopeIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variables instances which have on of the variable scope ids.
    
    Specified by:
    
    variableScopeIdIn in interface VariableInstanceQuery
  - activityInstanceIdIn
```
public VariableInstanceQuery activityInstanceIdIn(String... activityInstanceIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances which have one of the activity instance ids.
    
    Specified by:
    
    activityInstanceIdIn in interface VariableInstanceQuery
  - disableBinaryFetching
```
public VariableInstanceQuery disableBinaryFetching()
```
    Description copied from interface: VariableInstanceQuery
    
    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.
    
    Specified by:
    
    disableBinaryFetching in interface VariableInstanceQuery
    
    Returns:
    
    the query builder
  - disableCustomObjectDeserialization
```
public VariableInstanceQuery disableCustomObjectDeserialization()
```
    Description copied from interface: VariableInstanceQuery
    
    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.
    
    Specified by:
    
    disableCustomObjectDeserialization in interface VariableInstanceQuery
  - tenantIdIn
```
public VariableInstanceQuery tenantIdIn(String... tenantIds)
```
    Description copied from interface: VariableInstanceQuery
    
    Only select variable instances with one of the given tenant ids.
    
    Specified by:
    
    tenantIdIn in interface VariableInstanceQuery
  - orderByVariableName
```
public VariableInstanceQuery orderByVariableName()
```
    Description copied from interface: VariableInstanceQuery
    
    Order by variable name (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByVariableName in interface VariableInstanceQuery
  - orderByVariableType
```
public VariableInstanceQuery orderByVariableType()
```
    Description copied from interface: VariableInstanceQuery
    
    Order by variable type (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByVariableType in interface VariableInstanceQuery
  - orderByActivityInstanceId
```
public VariableInstanceQuery orderByActivityInstanceId()
```
    Description copied from interface: VariableInstanceQuery
    
    Order by activity instance id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByActivityInstanceId in interface VariableInstanceQuery
  - orderByTenantId
```
public VariableInstanceQuery orderByTenantId()
```
    Description copied from interface: VariableInstanceQuery
    
    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.
    
    Specified by:
    
    orderByTenantId in interface VariableInstanceQuery
  - hasExcludingConditions
```
protected boolean hasExcludingConditions()
```
    Description copied from class: AbstractQuery
    
    Whether or not the query has excluding conditions. If the query has excluding conditions, (e.g. task due date before and after are excluding), the SQL query is avoided and a default result is returned. The returned result is the same as if the SQL was executed and there were no entries.
    
    Overrides:
    
    hasExcludingConditions in class AbstractQuery<VariableInstanceQuery,VariableInstance>
    
    Returns:
    
    true if the query does have excluding conditions, false otherwise
  - executeCount
```
public long executeCount(CommandContext commandContext)
```
    Specified by:
    
    executeCount in class AbstractVariableQueryImpl<VariableInstanceQuery,VariableInstance>
  - executeList
```
public List<VariableInstance> executeList(CommandContext commandContext,
                                          Page page)
```
    Description copied from class: AbstractQuery
    
    Executes the actual query to retrieve the list of results.
    
    Specified by:
    
    executeList in class AbstractVariableQueryImpl<VariableInstanceQuery,VariableInstance>
    
    page - used if the results must be paged. If null, no paging will be applied.
  - shouldFetchValue
```
protected boolean shouldFetchValue(VariableInstanceEntity entity)
```
  - getVariableId
```
public String getVariableId()
```
  - getVariableName
```
public String getVariableName()
```
  - getVariableNames
```
public String[] getVariableNames()
```
  - getVariableNameLike
```
public String getVariableNameLike()
```
  - getExecutionIds
```
public String[] getExecutionIds()
```
  - getProcessInstanceIds
```
public String[] getProcessInstanceIds()
```
  - getCaseExecutionIds
```
public String[] getCaseExecutionIds()
```
  - getCaseInstanceIds
```
public String[] getCaseInstanceIds()
```
  - getTaskIds
```
public String[] getTaskIds()
```
  - getBatchIds
```
public String[] getBatchIds()
```
  - getVariableScopeIds
```
public String[] getVariableScopeIds()
```
  - getActivityInstanceIds
```
public String[] getActivityInstanceIds()
```

Constructor	Description
`VariableInstanceQueryImpl()`
`VariableInstanceQueryImpl(CommandExecutor commandExecutor)`

Class VariableInstanceQueryImpl

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

Field Summary

Fields inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

Constructor Summary

Method Summary

Methods inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.camunda.bpm.engine.impl.interceptor.Command

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

Methods inherited from interface org.camunda.bpm.engine.runtime.VariableInstanceQuery

Field Detail

variableId

variableName

variableNames

variableNameLike

executionIds

processInstanceIds

caseExecutionIds

caseInstanceIds

taskIds

batchIds

variableScopeIds

activityInstanceIds

tenantIds

isByteArrayFetchingEnabled

isCustomObjectDeserializationEnabled

Constructor Detail

VariableInstanceQueryImpl

VariableInstanceQueryImpl

Method Detail

variableId

variableName

variableNameIn

variableNameLike

executionIdIn

processInstanceIdIn

caseExecutionIdIn

caseInstanceIdIn

taskIdIn

batchIdIn

variableScopeIdIn

activityInstanceIdIn

disableBinaryFetching

disableCustomObjectDeserialization

tenantIdIn

orderByVariableName

orderByVariableType

orderByActivityInstanceId

orderByTenantId

hasExcludingConditions

executeCount

executeList

shouldFetchValue

getVariableId

getVariableName

getVariableNames

getVariableNameLike

getExecutionIds

getProcessInstanceIds

getCaseExecutionIds

getCaseInstanceIds

getTaskIds

getBatchIds

getVariableScopeIds

getActivityInstanceIds