| Package | Description | 
|---|---|
| org.camunda.bpm.engine | 
 Public API of the Camunda Platform engine. 
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 DeploymentsRuntimeService:
    For starting and searching ProcessInstancesTaskService:
    Exposes operations to manage human (standalone) Tasks,
    such as claiming, completing and assigning tasksIdentityService:
    Used for managing Users,
    Groups 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. | 
| org.camunda.bpm.engine.impl | 
 API implementation classes, which shouldn't directly be used by end-users. 
 | 
| org.camunda.bpm.engine.rest.dto.runtime | |
| org.camunda.bpm.engine.rest.sub.runtime.impl | |
| org.camunda.bpm.engine.runtime | 
 Classes related to the  
RuntimeService. | 
| Modifier and Type | Method and Description | 
|---|---|
VariableInstanceQuery | 
RuntimeService.createVariableInstanceQuery()
Creates a new  
VariableInstanceQuery instance, that can be used to query
 variable instances. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
VariableInstanceQueryImpl  | 
| Modifier and Type | Method and Description | 
|---|---|
protected VariableInstanceQuery | 
VariableInstanceQueryDto.createNewQuery(ProcessEngine engine)  | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
VariableInstanceQueryDto.applyFilters(VariableInstanceQuery query)  | 
protected void | 
VariableInstanceQueryDto.applySortBy(VariableInstanceQuery query,
           String sortBy,
           Map<String,Object> parameters,
           ProcessEngine engine)  | 
| Modifier and Type | Method and Description | 
|---|---|
protected VariableInstanceQuery | 
VariableInstanceResourceImpl.baseQuery()  | 
| Modifier and Type | Method and Description | 
|---|---|
protected Query<VariableInstanceQuery,VariableInstance> | 
VariableInstanceResourceImpl.baseQueryForBinaryVariable()  | 
protected Query<VariableInstanceQuery,VariableInstance> | 
VariableInstanceResourceImpl.baseQueryForVariable(boolean deserializeObjectValue)  | 
| Modifier and Type | Method and Description | 
|---|---|
VariableInstanceQuery | 
VariableInstanceQuery.activityInstanceIdIn(String... activityInstanceIds)
Only select variable instances which have one of the activity instance ids. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.caseExecutionIdIn(String... caseExecutionIds)
Only select variable instances which have one of the case execution ids. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.caseInstanceIdIn(String... caseInstanceIds)
Only select variable instances which have one of the case instance ids. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.disableBinaryFetching()
Disable fetching of byte array and file values. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.disableCustomObjectDeserialization()
Disable deserialization of variable values that are custom objects. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.executionIdIn(String... executionIds)
Only select variable instances which have one of the executions ids. 
 | 
VariableInstanceQuery | 
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 | 
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 | 
VariableInstanceQuery.orderByActivityInstanceId()
Order by activity instance id (needs to be followed by  
Query.asc() or Query.desc()). | 
VariableInstanceQuery | 
VariableInstanceQuery.orderByTenantId()
Order by tenant id (needs to be followed by  
Query.asc() or Query.desc()). | 
VariableInstanceQuery | 
VariableInstanceQuery.orderByVariableName()
Order by variable name (needs to be followed by  
Query.asc() or Query.desc()). | 
VariableInstanceQuery | 
VariableInstanceQuery.orderByVariableType()
Order by variable type (needs to be followed by  
Query.asc() or Query.desc()). | 
VariableInstanceQuery | 
VariableInstanceQuery.processInstanceIdIn(String... processInstanceIds)
Only select variable instances which have one of the process instance ids. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.taskIdIn(String... taskIds)
Only select variable instances which have one of the task ids. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.tenantIdIn(String... tenantIds)
Only select variable instances with one of the given tenant ids. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableId(String id)
Only select the variable with the given Id 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableName(String variableName)
Only select variable instances which have the variable name. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableNameIn(String... variableNames)
Only select variable instances which have one of the variables names. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableNameLike(String variableNameLike)
Only select variable instances which have the name like the assigned variable name. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableScopeIdIn(String... variableScopeIds)
Only select variables instances which have on of the variable scope ids. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableValueEquals(String name,
                   Object value)
Only select variables instances which have the given name and value. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableValueGreaterThan(String name,
                        Object value)
Only select variable instances which value is greater than the passed value. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableValueGreaterThanOrEqual(String name,
                               Object value)
Only select variable instances which value is greater than or equal to
 the passed value. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableValueLessThan(String name,
                     Object value)
Only select variable instances which value is less than the passed value. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableValueLessThanOrEqual(String name,
                            Object value)
Only select variable instances which value is less than or equal to the passed value. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableValueLike(String name,
                 String value)
Only select variable instances which value is like the given value. 
 | 
VariableInstanceQuery | 
VariableInstanceQuery.variableValueNotEquals(String name,
                      Object value)
Only select variable instances which have the given name, but
 with a different value than the passed value. 
 | 
Copyright © 2021. All rights reserved.