Uses of Interface
org.camunda.bpm.engine.runtime.VariableInstanceQuery
Package
Description
Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
Typical usage of the API starts by the creation of a
ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine
can be obtained.Through the services obtained from such a
ProcessEngine
, BPM and workflow operation
can be executed:RepositoryService
:
Manages Deployment
sRuntimeService
:
For starting and searching ProcessInstance
sTaskService
:
Exposes operations to manage human (standalone) Task
s,
such as claiming, completing and assigning tasksIdentityService
:
Used for managing User
s,
Group
s and the relations between themManagementService
:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService
:
Exposes information about ongoing and past process instances.FormService
:
Access to form data and rendered forms for starting new process instances and completing tasks.API implementation classes, which shouldn't directly be used by end-users.
Classes related to the
RuntimeService
.-
Uses of VariableInstanceQuery in org.camunda.bpm.engine
Modifier and TypeMethodDescriptionRuntimeService.createVariableInstanceQuery()
Creates a newVariableInstanceQuery
instance, that can be used to query variable instances. -
Uses of VariableInstanceQuery in org.camunda.bpm.engine.impl
Modifier and TypeMethodDescriptionVariableInstanceQueryImpl.activityInstanceIdIn
(String... activityInstanceIds) VariableInstanceQueryImpl.caseExecutionIdIn
(String... caseExecutionIds) VariableInstanceQueryImpl.caseInstanceIdIn
(String... caseInstanceIds) RuntimeServiceImpl.createVariableInstanceQuery()
VariableInstanceQueryImpl.disableBinaryFetching()
VariableInstanceQueryImpl.disableCustomObjectDeserialization()
VariableInstanceQueryImpl.executionIdIn
(String... executionIds) VariableInstanceQueryImpl.orderByActivityInstanceId()
VariableInstanceQueryImpl.orderByTenantId()
VariableInstanceQueryImpl.orderByVariableName()
VariableInstanceQueryImpl.orderByVariableType()
VariableInstanceQueryImpl.processInstanceIdIn
(String... processInstanceIds) VariableInstanceQueryImpl.tenantIdIn
(String... tenantIds) VariableInstanceQueryImpl.variableId
(String id) VariableInstanceQueryImpl.variableName
(String variableName) VariableInstanceQueryImpl.variableNameIn
(String... variableNames) VariableInstanceQueryImpl.variableNameLike
(String variableNameLike) VariableInstanceQueryImpl.variableScopeIdIn
(String... variableScopeIds) -
Uses of VariableInstanceQuery in org.camunda.bpm.engine.rest.dto.runtime
Modifier and TypeMethodDescriptionprotected VariableInstanceQuery
VariableInstanceQueryDto.createNewQuery
(ProcessEngine engine) Modifier and TypeMethodDescriptionprotected void
VariableInstanceQueryDto.applyFilters
(VariableInstanceQuery query) protected void
VariableInstanceQueryDto.applySortBy
(VariableInstanceQuery query, String sortBy, Map<String, Object> parameters, ProcessEngine engine) -
Uses of VariableInstanceQuery in org.camunda.bpm.engine.rest.sub.runtime.impl
Modifier and TypeMethodDescriptionprotected VariableInstanceQuery
VariableInstanceResourceImpl.baseQuery()
Modifier and TypeMethodDescriptionprotected Query<VariableInstanceQuery,
VariableInstance> VariableInstanceResourceImpl.baseQueryForBinaryVariable()
protected Query<VariableInstanceQuery,
VariableInstance> VariableInstanceResourceImpl.baseQueryForVariable
(boolean deserializeObjectValue) -
Uses of VariableInstanceQuery in org.camunda.bpm.engine.runtime
Modifier and TypeMethodDescriptionVariableInstanceQuery.activityInstanceIdIn
(String... activityInstanceIds) Only select variable instances which have one of the activity instance ids.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 allvariableValueXXX
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 allvariableValueXXX
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 byQuery.asc()
orQuery.desc()
).VariableInstanceQuery.orderByTenantId()
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).VariableInstanceQuery.orderByVariableName()
Order by variable name (needs to be followed byQuery.asc()
orQuery.desc()
).VariableInstanceQuery.orderByVariableType()
Order by variable type (needs to be followed byQuery.asc()
orQuery.desc()
).VariableInstanceQuery.processInstanceIdIn
(String... processInstanceIds) Only select variable instances which have one of the process instance ids.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 IdVariableInstanceQuery.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.