# Uses of Interface
org.flowable.variable.api.persistence.entity.VariableInstance

Packages that use VariableInstance
Package
Description
org.flowable.cmmn.api
org.flowable.cmmn.api.delegate
org.flowable.engine
Public API of the Flowable 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 `Deployment`s.
`RuntimeService`: For starting and searching `ProcessInstance`s.
`TaskService`: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks.
`IdentityService`: Used for managing users, groups and the relations between them.
`ManagementService`: Exposes engine administration and maintenance operations, which have no relation to the runtime exection of business processes.
`HistoryService`: 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.flowable.engine.compatibility
org.flowable.engine.delegate.variable
org.flowable.variable.api.delegate

- ## Uses of VariableInstance in org.flowable.cmmn.api

  Methods in org.flowable.cmmn.api that return VariableInstance
  Modifier and Type
  Method
  Description
  `VariableInstance`
  CmmnRuntimeService.`getLocalVariableInstance(String planItemInstanceId, String variableName)`
  The local variable.
  `VariableInstance`
  CmmnRuntimeService.`getVariableInstance(String caseInstanceId, String variableName)`
  The variable.
  `VariableInstance`
  CmmnTaskService.`getVariableInstance(String taskId, String variableName)`
  The variable.
  `VariableInstance`
  CmmnTaskService.`getVariableInstanceLocal(String taskId, String variableName)`
  The variable for a task.
  Methods in org.flowable.cmmn.api that return types with arguments of type VariableInstance
  Modifier and Type
  Method
  Description
  `Map<String,VariableInstance>`
  CmmnRuntimeService.`getLocalVariableInstances(String planItemInstanceId)`
  All variable values that are defined in the plan item instance scope, without taking outer scopes into account.
  `Map<String,VariableInstance>`
  CmmnRuntimeService.`getVariableInstances(String caseInstanceId)`
  All variables visible from the given case instance scope.
  `Map<String,VariableInstance>`
  CmmnTaskService.`getVariableInstances(String taskId)`
  All variables visible from the given task scope (including parent scopes).
  `Map<String,VariableInstance>`
  CmmnTaskService.`getVariableInstances(String taskId, Collection<String> variableNames)`
  The variable values for all given variableNames, takes all variables into account which are visible from the given task scope (including parent scopes).
  `Map<String,VariableInstance>`
  CmmnTaskService.`getVariableInstancesLocal(String taskId)`
  All variable values that are defined in the task scope, without taking outer scopes into account.
  `Map<String,VariableInstance>`
  CmmnTaskService.`getVariableInstancesLocal(String taskId, Collection<String> variableNames)`
  The variable values for all given variableNames that are defined in the given task's scope.
  `List<VariableInstance>`
  CmmnTaskService.`getVariableInstancesLocalByTaskIds(Set<String> taskIds)`
  get all variables and search only in the task scope.

- ## Uses of VariableInstance in org.flowable.cmmn.api.delegate

  Method parameters in org.flowable.cmmn.api.delegate with type arguments of type VariableInstance
  Modifier and Type
  Method
  Description
  `Object`
  PlanItemVariableAggregator.`aggregateMultiVariables(DelegatePlanItemInstance planItemInstance, List<? extends VariableInstance> instances, PlanItemVariableAggregatorContext context)`
  Aggregated the provided variable instances into one variable value.

- ## Uses of VariableInstance in org.flowable.engine

  Methods in org.flowable.engine that return VariableInstance
  Modifier and Type
  Method
  Description
  `VariableInstance`
  RuntimeService.`getVariableInstance(String executionId, String variableName)`
  The variable.
  `VariableInstance`
  TaskService.`getVariableInstance(String taskId, String variableName)`
  The variable.
  `VariableInstance`
  RuntimeService.`getVariableInstanceLocal(String executionId, String variableName)`
  The variable for an execution.
  `VariableInstance`
  TaskService.`getVariableInstanceLocal(String taskId, String variableName)`
  The variable for a task.
  Methods in org.flowable.engine that return types with arguments of type VariableInstance
  Modifier and Type
  Method
  Description
  `Map<String,VariableInstance>`
  RuntimeService.`getVariableInstances(String executionId)`
  All variables visible from the given execution scope (including parent scopes).
  `Map<String,VariableInstance>`
  RuntimeService.`getVariableInstances(String executionId, Collection<String> variableNames)`
  The variable values for all given variableNames, takes all variables into account which are visible from the given execution scope (including parent scopes).
  `Map<String,VariableInstance>`
  TaskService.`getVariableInstances(String taskId)`
  All variables visible from the given task scope (including parent scopes).
  `Map<String,VariableInstance>`
  TaskService.`getVariableInstances(String taskId, Collection<String> variableNames)`
  The variable values for all given variableNames, takes all variables into account which are visible from the given task scope (including parent scopes).
  `List<VariableInstance>`
  RuntimeService.`getVariableInstancesByExecutionIds(Set<String> executionIds)`
  All variables visible from the given execution scope (including parent scopes).
  `Map<String,VariableInstance>`
  RuntimeService.`getVariableInstancesLocal(String executionId)`
  All variable values that are defined in the execution scope, without taking outer scopes into account.
  `Map<String,VariableInstance>`
  RuntimeService.`getVariableInstancesLocal(String executionId, Collection<String> variableNames)`
  The variable values for the given variableNames only taking the given execution scope into account, not looking in outer scopes.
  `Map<String,VariableInstance>`
  TaskService.`getVariableInstancesLocal(String taskId)`
  All variable values that are defined in the task scope, without taking outer scopes into account.
  `Map<String,VariableInstance>`
  TaskService.`getVariableInstancesLocal(String taskId, Collection<String> variableNames)`
  The variable values for all given variableNames that are defined in the given task's scope.
  `List<VariableInstance>`
  TaskService.`getVariableInstancesLocalByTaskIds(Set<String> taskIds)`
  get all variables and search only in the task scope.

- ## Uses of VariableInstance in org.flowable.engine.compatibility

  Methods in org.flowable.engine.compatibility that return VariableInstance
  Modifier and Type
  Method
  Description
  `VariableInstance`
  Flowable5CompatibilityHandler.`getExecutionVariableInstance(String executionId, String variableName, boolean isLocal)`
  Methods in org.flowable.engine.compatibility that return types with arguments of type VariableInstance
  Modifier and Type
  Method
  Description
  `Map<String,VariableInstance>`
  Flowable5CompatibilityHandler.`getExecutionVariableInstances(String executionId, Collection<String> variableNames, boolean isLocal)`

- ## Uses of VariableInstance in org.flowable.engine.delegate.variable

  Method parameters in org.flowable.engine.delegate.variable with type arguments of type VariableInstance
  Modifier and Type
  Method
  Description
  `Object`
  VariableAggregator.`aggregateMultiVariables(DelegateExecution execution, List<? extends VariableInstance> instances, VariableAggregatorContext context)`
  Aggregated the provided variable instances into one variable value.

- ## Uses of VariableInstance in org.flowable.variable.api.delegate

  Methods in org.flowable.variable.api.delegate that return VariableInstance
  Modifier and Type
  Method
  Description
  `VariableInstance`
  VariableScope.`getVariableInstance(String variableName)`
  Similar to `VariableScope.getVariable(String)`, but returns a `VariableInstance` instance, which contains more information than just the value.
  `VariableInstance`
  VariableScope.`getVariableInstance(String variableName, boolean fetchAllVariables)`
  Similar to `VariableScope.getVariable(String, boolean)`, but returns an instance of `VariableInstance`, which has some additional information beyond the value.
  `VariableInstance`
  VariableScope.`getVariableInstanceLocal(String variableName)`
  Similar to `VariableScope.getVariableLocal(String)`, but returns an instance of `VariableInstance`, which has some additional information beyond the value.
  `VariableInstance`
  VariableScope.`getVariableInstanceLocal(String variableName, boolean fetchAllVariables)`
  Similar to `VariableScope.getVariableLocal(String, boolean)`, but returns an instance of `VariableInstance`, which has some additional information beyond the value.
  Methods in org.flowable.variable.api.delegate that return types with arguments of type VariableInstance
  Modifier and Type
  Method
  Description
  `Map<String,VariableInstance>`
  VariableScope.`getVariableInstances()`
  Returns all variables, as instances of the `VariableInstance` interface, which gives more information than only the value (type, execution id, etc.)
  `Map<String,VariableInstance>`
  VariableScope.`getVariableInstances(Collection<String> variableNames)`
  Similar to `VariableScope.getVariableInstances()`, but limited to only the variables with the provided names.
  `Map<String,VariableInstance>`
  VariableScope.`getVariableInstances(Collection<String> variableNames, boolean fetchAllVariables)`
  Similar to `VariableScope.getVariables(Collection, boolean)` but returns the variables as instances of the `VariableInstance` interface, which gives more information than only the value (type, execution id, etc.)
  `Map<String,VariableInstance>`
  VariableScope.`getVariableInstancesLocal()`
  Returns the variables local to this scope as instances of the `VariableInstance` interface, which provided additional information about the variable.
  `Map<String,VariableInstance>`
  VariableScope.`getVariableInstancesLocal(Collection<String> variableNames)`
  Similar to `VariableScope.getVariableInstances(Collection)`, but only for variables local to this scope.
  `Map<String,VariableInstance>`
  VariableScope.`getVariableInstancesLocal(Collection<String> variableNames, boolean fetchAllVariables)`
  Similar to `VariableScope.getVariableInstances(Collection, boolean)`, but only for variables local to this scope.