Package org.flowable.variable.api.runtime

Interface VariableInstanceQuery

All Superinterfaces:

org.flowable.common.engine.api.query.Query<VariableInstanceQuery,VariableInstance>

public interface VariableInstanceQuery
extends org.flowable.common.engine.api.query.Query<VariableInstanceQuery,VariableInstance>

Programmatic querying for VariableInstances.

Author:

Joram Barrez, Tijs Rademakers

Nested Class Summary

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

org.flowable.common.engine.api.query.Query.NullHandlingOnOrder

Method Summary

Modifier and Type	Method	Description
VariableInstanceQuery	excludeLocalVariables()	Only select historic process variables which were not set local.
VariableInstanceQuery	excludeTaskVariables()	Only select historic process variables which were not set task-local.
VariableInstanceQuery	excludeVariableInitialization()	Don't initialize variable values.
VariableInstanceQuery	executionId(String executionId)	Only select historic process variables with the given id.
VariableInstanceQuery	executionIds(Set<String> executionIds)	Only select historic process variables whose id is in the given set of ids.
VariableInstanceQuery	id(String id)	Only select a historic variable with the given id.
VariableInstanceQuery	orderByProcessInstanceId()
VariableInstanceQuery	orderByVariableName()
VariableInstanceQuery	processInstanceId(String processInstanceId)	Only select historic process variables with the given process instance.
VariableInstanceQuery	scopeId(String scopeId)	Only select historic variables with the given scope id.
VariableInstanceQuery	scopeType(String scopeType)	Only select historic variables with the give scope type.
VariableInstanceQuery	subScopeId(String subScopeId)	Only select historic variables with the given sub scope id.
VariableInstanceQuery	taskId(String taskId)	Only select historic process variables with the given task.
VariableInstanceQuery	taskIds(Set<String> taskIds)	Only select historic process variables whose id is in the given set of ids.
VariableInstanceQuery	variableName(String variableName)	Only select historic process variables with the given variable name.
VariableInstanceQuery	variableNameLike(String variableNameLike)	Only select historic process variables where the given variable name is like.
VariableInstanceQuery	variableValueEquals(String variableName, Object variableValue)	only select historic process variables with the given name and value
VariableInstanceQuery	variableValueLike(String variableName, String variableValue)	only select historic process variables like the given name and value
VariableInstanceQuery	variableValueLikeIgnoreCase(String variableName, String variableValue)	only select historic process variables like the given name and value (case insensitive)
VariableInstanceQuery	variableValueNotEquals(String variableName, Object variableValue)	only select historic process variables that don't have the given name and value

Methods inherited from interface org.flowable.common.engine.api.query.Query

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Method Detail

id

VariableInstanceQuery id(String id)

Only select a historic variable with the given id.

processInstanceId

VariableInstanceQuery processInstanceId(String processInstanceId)

Only select historic process variables with the given process instance.

executionId

VariableInstanceQuery executionId(String executionId)

Only select historic process variables with the given id.

executionIds

VariableInstanceQuery executionIds(Set<String> executionIds)

Only select historic process variables whose id is in the given set of ids.

taskId

VariableInstanceQuery taskId(String taskId)

Only select historic process variables with the given task.

taskIds

VariableInstanceQuery taskIds(Set<String> taskIds)

Only select historic process variables whose id is in the given set of ids.

variableName

VariableInstanceQuery variableName(String variableName)

Only select historic process variables with the given variable name.

variableNameLike

VariableInstanceQuery variableNameLike(String variableNameLike)

Only select historic process variables where the given variable name is like.

excludeTaskVariables

VariableInstanceQuery excludeTaskVariables()

Only select historic process variables which were not set task-local.

excludeVariableInitialization

VariableInstanceQuery excludeVariableInitialization()

Don't initialize variable values. This is foremost a way to deal with variable delete queries

variableValueEquals

VariableInstanceQuery variableValueEquals(String variableName,
                                          Object variableValue)

only select historic process variables with the given name and value

variableValueNotEquals

VariableInstanceQuery variableValueNotEquals(String variableName,
                                             Object variableValue)

only select historic process variables that don't have the given name and value

variableValueLike

VariableInstanceQuery variableValueLike(String variableName,
                                        String variableValue)

only select historic process variables like the given name and value

variableValueLikeIgnoreCase

VariableInstanceQuery variableValueLikeIgnoreCase(String variableName,
                                                  String variableValue)

only select historic process variables like the given name and value (case insensitive)

scopeId

VariableInstanceQuery scopeId(String scopeId)

Only select historic variables with the given scope id.

subScopeId

VariableInstanceQuery subScopeId(String subScopeId)

Only select historic variables with the given sub scope id.

scopeType

VariableInstanceQuery scopeType(String scopeType)

Only select historic variables with the give scope type.

excludeLocalVariables

VariableInstanceQuery excludeLocalVariables()

Only select historic process variables which were not set local.

orderByProcessInstanceId

VariableInstanceQuery orderByProcessInstanceId()

orderByVariableName

VariableInstanceQuery orderByVariableName()