org.camunda.bpm.engine.runtime

Interface VariableInstanceQuery

All Superinterfaces:

Query<VariableInstanceQuery,VariableInstance>

All Known Implementing Classes:

VariableInstanceQueryImpl

public interface VariableInstanceQuery
extends Query<VariableInstanceQuery,VariableInstance>

Author:

roman.smirnov

Method Summary

Methods

Modifier and Type	Method and Description
VariableInstanceQuery	activityInstanceIdIn(String... activityInstanceIds) Only select variable instances which have one of the activity instance ids.
VariableInstanceQuery	disableBinaryFetching() Disable fetching of byte array values.
VariableInstanceQuery	executionIdIn(String... executionIds) Only select variable instances which have one of the executions ids.
VariableInstanceQuery	orderByActivityInstanceId() Order by activity instance 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	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	variableNameLike(String variableNameLike) Only select variable instances which have the name like the assigned variable name.
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

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.

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.

taskIdIn

VariableInstanceQuery taskIdIn(String... taskIds)

Only select variable instances which have one of the task ids.

activityInstanceIdIn

VariableInstanceQuery activityInstanceIdIn(String... activityInstanceIds)

Only select variable instances which have one of the activity instance ids.

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#getVariableTypes(). 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 values. By default, the query will fetch the value of a byte array. By calling this method you can prevent the values of (potentially large) blob data chunks to be fetched.

Returns:

the query builder

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%).

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()).