VariableScopeImpl (Flowable 6.7.0 API)

java.lang.Object
- org.flowable.common.engine.impl.persistence.entity.AbstractEntity
- - org.flowable.variable.service.impl.persistence.entity.VariableScopeImpl

All Implemented Interfaces:

Serializable, VariableContainer, HasRevision, Entity, VariableScope

Direct Known Subclasses:

AbstractBpmnEngineVariableScopeEntity, AbstractCmmnEngineVariableScopeEntity, AbstractTaskServiceVariableScopeEntity
```
public abstract class VariableScopeImpl
extends AbstractEntity
implements Serializable, VariableScope
```
Author:

Tom Baeyens, Joram Barrez, Tijs Rademakers, Saeid Mirzaei

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected ELContext`	`cachedElContext`
`protected Map<String,VariableInstance>`	`transientVariables`
`protected Map<String,VariableInstanceEntity>`	`usedVariablesCache`
`protected Map<String,VariableInstanceEntity>`	`variableInstances`

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

Constructor Summary

Constructors
Constructor and Description

VariableScopeImpl()

Constructors
Constructor and Description
`VariableScopeImpl()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`addLoggingSessionInfo(com.fasterxml.jackson.databind.node.ObjectNode loggingNode)`
`protected Map<String,Object>`	`collectTransientVariables(HashMap<String,Object> variables)`
`protected Map<String,VariableInstance>`	`collectVariableInstances(HashMap<String,VariableInstance> variables)`
`protected Set<String>`	`collectVariableNames(Set<String> variableNames)`
`protected Map<String,Object>`	`collectVariables(HashMap<String,Object> variables)`
`protected VariableInstanceEntity`	`createVariableInstance(String variableName, Object value)`
`protected void`	`createVariableLocal(String variableName, Object value)` only called when a new variable is created on this variable scope.
`void`	`createVariablesLocal(Map<String,? extends Object> variables)`
`protected void`	`deleteVariableInstanceForExplicitUserCall(VariableInstanceEntity variableInstance)`
`protected void`	`ensureVariableInstancesInitialized()`
`ELContext`	`getCachedElContext()`
`protected abstract VariableScopeImpl`	`getParentVariableScope()`
`protected abstract VariableInstanceEntity`	`getSpecificVariable(String variableName)`
`protected abstract List<VariableInstanceEntity>`	`getSpecificVariables(Collection<String> variableNames)`
`Object`	`getTransientVariable(String variableName)` Similar to `VariableScope.getVariable(String)`, including the searching via the parent scopes, but for transient variables only.
`Object`	`getTransientVariableLocal(String variableName)` Similar to `VariableScope.getVariableLocal(String)`, but for a transient variable.
`Map<String,Object>`	`getTransientVariables()` Similar to `VariableScope.getVariables()`, but for transient variables only.
`Map<String,Object>`	`getTransientVariablesLocal()` Similar to `VariableScope.getVariableLocal(String)`, but for transient variables only.
`Map<String,VariableInstanceEntity>`	`getUsedVariablesCache()`
`Object`	`getVariable(String variableName)` Returns the variable value for one specific variable.
`Object`	`getVariable(String variableName, boolean fetchAllVariables)` The same operation as `getVariable(String)`, but with an extra parameter to indicate whether or not all variables need to be fetched.
`<T> T`	`getVariable(String variableName, Class<T> variableClass)` Typed version of the `VariableScope.getVariable(String)` method.
`VariableInstance`	`getVariableInstance(String variableName)` Similar to `VariableScope.getVariable(String)`, but returns a `VariableInstance` instance, which contains more information than just the value.
`VariableInstance`	`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.
`Map<String,VariableInstanceEntity>`	`getVariableInstanceEntities()`
`VariableInstance`	`getVariableInstanceLocal(String variableName)` Similar to `VariableScope.getVariableLocal(String)`, but returns an instance of `VariableInstance`, which has some additional information beyond the value.
`VariableInstance`	`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.
`Map<String,VariableInstance>`	`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>`	`getVariableInstances(Collection<String> variableNames)` Similar to `VariableScope.getVariableInstances()`, but limited to only the variables with the provided names.
`Map<String,VariableInstance>`	`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>`	`getVariableInstancesLocal()` Returns the variables local to this scope as instances of the `VariableInstance` interface, which provided additional information about the variable.
`Map<String,VariableInstance>`	`getVariableInstancesLocal(Collection<String> variableNames)` Similar to `VariableScope.getVariableInstances(Collection)`, but only for variables local to this scope.
`Map<String,VariableInstance>`	`getVariableInstancesLocal(Collection<String> variableNames, boolean fetchAllVariables)` Similar to `VariableScope.getVariableInstances(Collection, boolean)`, but only for variables local to this scope.
`Object`	`getVariableLocal(String variableName)` Returns the value for the specific variable and only checks this scope and not any parent scope.
`Object`	`getVariableLocal(String variableName, boolean fetchAllVariables)` Similar to `VariableScope.getVariableLocal(String)`, but has an extra flag that indicates whether or not all variables need to be fetched when getting one variable.
`<T> T`	`getVariableLocal(String variableName, Class<T> variableClass)` Typed version of the `VariableScope.getVariableLocal(String)` method.
`Set<String>`	`getVariableNames()` Returns all the names of the variables for this scope and all parent scopes.
`Set<String>`	`getVariableNamesLocal()` Returns all the names of the variables for this scope (no parent scopes).
`Map<String,Object>`	`getVariables()` Returns all variables.
`Map<String,Object>`	`getVariables(Collection<String> variableNames)` Similar to `VariableScope.getVariables()`, but limited to only the variables with the provided names.
`Map<String,Object>`	`getVariables(Collection<String> variableNames, boolean fetchAllVariables)` Similar to `VariableScope.getVariables(Collection)`, but with a flag that indicates that all variables should be fetched when fetching the specific variables.
`protected abstract VariableServiceConfiguration`	`getVariableServiceConfiguration()`
`Map<String,Object>`	`getVariablesLocal()` Returns the variable local to this scope only.
`Map<String,Object>`	`getVariablesLocal(Collection<String> variableNames)` Similar to `VariableScope.getVariables(Collection)`, but only for variables local to this scope.
`Map<String,Object>`	`getVariablesLocal(Collection<String> variableNames, boolean fetchAllVariables)` Similar to `VariableScope.getVariables(Collection, boolean)`, but only for variables local to this scope.
`boolean`	`hasVariable(String variableName)` Returns whether this scope or any parent scope has a specific variable.
`boolean`	`hasVariableLocal(String variableName)` Returns whether this scope has a specific variable.
`boolean`	`hasVariables()` Returns whether this scope or any parent scope has variables.
`boolean`	`hasVariablesLocal()` Returns whether this scope has variables.
`protected abstract void`	`initializeVariableInstanceBackPointer(VariableInstanceEntity variableInstance)`
`void`	`internalSetVariableInstances(Map<String,VariableInstanceEntity> variableInstances)` Only to be used when creating a new entity, to avoid an extra call to the database.
`protected boolean`	`isExpression(String variableName)`
`protected abstract boolean`	`isPropagateToHistoricVariable()` Return whether changes to the variables are propagated to the history storage.
`protected abstract Collection<VariableInstanceEntity>`	`loadVariableInstances()`
`void`	`removeTransientVariable(String variableName)` Removes a specific transient variable.
`void`	`removeTransientVariableLocal(String variableName)` Removes a specific transient variable (also searching parent scopes).
`void`	`removeTransientVariables()` Remove all transient variable of this scope and its parent scopes.
`void`	`removeTransientVariablesLocal()` Removes all local transient variables.
`void`	`removeVariable(String variableName)` Removes the variable and creates a new HistoricVariableUpdate.
`void`	`removeVariableLocal(String variableName)` Removes the local variable and creates a new HistoricVariableUpdate.
`void`	`removeVariables()` Removes the (local) variables and creates a new HistoricVariableUpdate for each of them.
`void`	`removeVariables(Collection<String> variableNames)` Removes the variables and creates a new HistoricVariableUpdate for each of them.
`void`	`removeVariablesLocal()` Removes the (local) variables and creates a new HistoricVariableUpdate for each of them.
`void`	`removeVariablesLocal(Collection<String> variableNames)` Removes the local variables and creates a new HistoricVariableUpdate for each of them.
`void`	`setCachedElContext(ELContext cachedElContext)`
`void`	`setTransientVariable(String variableName, Object variableValue)` Similar to `VariableScope.setVariable(String, Object)`, but the variable is transient: - no history is kept for the variable - the variable is only available until a waitstate is reached in the process - transient variables 'shadow' persistent variable (when getVariable('abc') where 'abc' is both persistent and transient, the transient value is returned.
`void`	`setTransientVariableLocal(String variableName, Object variableValue)` Similar to `VariableScope.setVariableLocal(String, Object)`, but for a transient variable.
`void`	`setTransientVariables(Map<String,Object> transientVariables)` Similar to `VariableScope.setVariables(Map)`, but for transient variables.
`void`	`setTransientVariablesLocal(Map<String,Object> transientVariables)` Similar to `VariableScope.setVariablesLocal(Map)`, but for transient variables.
`void`	`setVariable(String variableName, Object value)` Sets the variable with the provided name to the provided value.
`void`	`setVariable(String variableName, Object value, boolean fetchAllVariables)` The default `setVariable(String, Object)` fetches all variables (for historical and backwards compatible reasons) while setting the variables.
`Object`	`setVariableLocal(String variableName, Object value)` Similar to `VariableScope.setVariable(String, Object)`, but the variable is set to this scope specifically.
`Object`	`setVariableLocal(String variableName, Object value, boolean fetchAllVariables)` The default `setVariableLocal(String, Object)` fetches all variables (for historical and backwards compatible reasons) while setting the variables.
`void`	`setVariables(Map<String,? extends Object> variables)` Sets the provided variables to the variable scope.
`void`	`setVariablesLocal(Map<String,? extends Object> variables)` Similar to `VariableScope.setVariables(Map)`, but the variable are set on this scope specifically.
`protected boolean`	`storeVariableLocal(String variableName)`
`protected void`	`updateVariableInstance(VariableInstanceEntity variableInstance, Object value)`

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.api.variable.VariableContainer
getTenantId

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity
getIdPrefix, getPersistentState

- Field Detail
  - variableInstances
```
protected Map<String,VariableInstanceEntity> variableInstances
```
  - usedVariablesCache
```
protected Map<String,VariableInstanceEntity> usedVariablesCache
```
  - transientVariables
```
protected Map<String,VariableInstance> transientVariables
```
  - cachedElContext
```
protected ELContext cachedElContext
```
- Constructor Detail
  - VariableScopeImpl
```
public VariableScopeImpl()
```
- Method Detail
  - loadVariableInstances
```
protected abstract Collection<VariableInstanceEntity> loadVariableInstances()
```
  - getParentVariableScope
```
protected abstract VariableScopeImpl getParentVariableScope()
```
  - initializeVariableInstanceBackPointer
```
protected abstract void initializeVariableInstanceBackPointer(VariableInstanceEntity variableInstance)
```
  - addLoggingSessionInfo
```
protected abstract void addLoggingSessionInfo(com.fasterxml.jackson.databind.node.ObjectNode loggingNode)
```
  - ensureVariableInstancesInitialized
```
protected void ensureVariableInstancesInitialized()
```
  - internalSetVariableInstances
```
public void internalSetVariableInstances(Map<String,VariableInstanceEntity> variableInstances)
```
    Only to be used when creating a new entity, to avoid an extra call to the database.
  - getVariables
```
public Map<String,Object> getVariables()
```
    Description copied from interface: VariableScope
    
    Returns all variables. This will include all variables of parent scopes too.
    
    Specified by:
    
    getVariables in interface VariableScope
  - getVariableInstances
```
public Map<String,VariableInstance> getVariableInstances()
```
    Description copied from interface: VariableScope
    
    Returns all variables, as instances of the VariableInstance interface, which gives more information than only the value (type, execution id, etc.)
    
    Specified by:
    
    getVariableInstances in interface VariableScope
  - getVariables
```
public Map<String,Object> getVariables(Collection<String> variableNames)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariables(), but limited to only the variables with the provided names.
    
    Specified by:
    
    getVariables in interface VariableScope
  - getVariableInstances
```
public Map<String,VariableInstance> getVariableInstances(Collection<String> variableNames)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariableInstances(), but limited to only the variables with the provided names.
    
    Specified by:
    
    getVariableInstances in interface VariableScope
  - getVariables
```
public Map<String,Object> getVariables(Collection<String> variableNames,
                                       boolean fetchAllVariables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariables(Collection), but with a flag that indicates that all variables should be fetched when fetching the specific variables. If set to false, only the specific variables will be fetched. Depending on the use case, this can be better for performance, as it avoids fetching and processing the other variables. However, if the other variables are needed further on, getting them in one go is probably better (and the variables are cached during one Command execution).
    
    Specified by:
    
    getVariables in interface VariableScope
  - getVariableInstances
```
public Map<String,VariableInstance> getVariableInstances(Collection<String> variableNames,
                                                         boolean fetchAllVariables)
```
    Description copied from interface: VariableScope
    
    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.)
    
    Specified by:
    
    getVariableInstances in interface VariableScope
  - collectVariables
```
protected Map<String,Object> collectVariables(HashMap<String,Object> variables)
```
  - collectVariableInstances
```
protected Map<String,VariableInstance> collectVariableInstances(HashMap<String,VariableInstance> variables)
```
  - getVariable
```
public Object getVariable(String variableName)
```
    Description copied from interface: VariableScope
    
    Returns the variable value for one specific variable. Will look in parent scopes when the variable does not exist on this particular scope.
    
    Specified by:
    
    getVariable in interface VariableContainer
    
    Specified by:
    
    getVariable in interface VariableScope
  - getVariableInstance
```
public VariableInstance getVariableInstance(String variableName)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariable(String), but returns a VariableInstance instance, which contains more information than just the value.
    
    Specified by:
    
    getVariableInstance in interface VariableScope
  - getVariable
```
public Object getVariable(String variableName,
                          boolean fetchAllVariables)
```
    The same operation as getVariable(String), but with an extra parameter to indicate whether or not all variables need to be fetched. Note that the default way (because of backwards compatibility) is to fetch all the variables when doing a get/set of variables. So this means 'true' is the default value for this method, and in fact it will simply delegate to getVariable(String). This can also be the most performant, if you're doing a lot of variable gets in the same transaction (eg in service tasks). In case 'false' is used, only the specific variable will be fetched.
    
    Specified by:
    
    getVariable in interface VariableScope
  - getVariableInstance
```
public VariableInstance getVariableInstance(String variableName,
                                            boolean fetchAllVariables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariable(String, boolean), but returns an instance of VariableInstance, which has some additional information beyond the value.
    
    Specified by:
    
    getVariableInstance in interface VariableScope
  - getSpecificVariable
```
protected abstract VariableInstanceEntity getSpecificVariable(String variableName)
```
  - getVariableLocal
```
public Object getVariableLocal(String variableName)
```
    Description copied from interface: VariableScope
    
    Returns the value for the specific variable and only checks this scope and not any parent scope.
    
    Specified by:
    
    getVariableLocal in interface VariableScope
  - getVariableInstanceLocal
```
public VariableInstance getVariableInstanceLocal(String variableName)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariableLocal(String), but returns an instance of VariableInstance, which has some additional information beyond the value.
    
    Specified by:
    
    getVariableInstanceLocal in interface VariableScope
  - getVariableLocal
```
public Object getVariableLocal(String variableName,
                               boolean fetchAllVariables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariableLocal(String), but has an extra flag that indicates whether or not all variables need to be fetched when getting one variable. By default true (for backwards compatibility reasons), which means that calling VariableScope.getVariableLocal(String) will fetch all variables, of the current scope. Setting this flag to false can thus be better for performance. However, variables are cached, and if other variables are used later on, setting this true might actually be better for performance.
    
    Specified by:
    
    getVariableLocal in interface VariableScope
  - getVariableInstanceLocal
```
public VariableInstance getVariableInstanceLocal(String variableName,
                                                 boolean fetchAllVariables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariableLocal(String, boolean), but returns an instance of VariableInstance, which has some additional information beyond the value.
    
    Specified by:
    
    getVariableInstanceLocal in interface VariableScope
  - hasVariables
```
public boolean hasVariables()
```
    Description copied from interface: VariableScope
    
    Returns whether this scope or any parent scope has variables.
    
    Specified by:
    
    hasVariables in interface VariableScope
  - hasVariablesLocal
```
public boolean hasVariablesLocal()
```
    Description copied from interface: VariableScope
    
    Returns whether this scope has variables.
    
    Specified by:
    
    hasVariablesLocal in interface VariableScope
  - hasVariable
```
public boolean hasVariable(String variableName)
```
    Description copied from interface: VariableScope
    
    Returns whether this scope or any parent scope has a specific variable.
    
    Specified by:
    
    hasVariable in interface VariableContainer
    
    Specified by:
    
    hasVariable in interface VariableScope
  - hasVariableLocal
```
public boolean hasVariableLocal(String variableName)
```
    Description copied from interface: VariableScope
    
    Returns whether this scope has a specific variable.
    
    Specified by:
    
    hasVariableLocal in interface VariableScope
  - collectVariableNames
```
protected Set<String> collectVariableNames(Set<String> variableNames)
```
  - getVariableNames
```
public Set<String> getVariableNames()
```
    Description copied from interface: VariableScope
    
    Returns all the names of the variables for this scope and all parent scopes.
    
    Specified by:
    
    getVariableNames in interface VariableScope
  - getVariablesLocal
```
public Map<String,Object> getVariablesLocal()
```
    Description copied from interface: VariableScope
    
    Returns the variable local to this scope only. So, in contrary to VariableScope.getVariables(), the variables from the parent scope won't be returned.
    
    Specified by:
    
    getVariablesLocal in interface VariableScope
  - getVariableInstancesLocal
```
public Map<String,VariableInstance> getVariableInstancesLocal()
```
    Description copied from interface: VariableScope
    
    Returns the variables local to this scope as instances of the VariableInstance interface, which provided additional information about the variable.
    
    Specified by:
    
    getVariableInstancesLocal in interface VariableScope
  - getVariablesLocal
```
public Map<String,Object> getVariablesLocal(Collection<String> variableNames)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariables(Collection), but only for variables local to this scope.
    
    Specified by:
    
    getVariablesLocal in interface VariableScope
  - getVariableInstancesLocal
```
public Map<String,VariableInstance> getVariableInstancesLocal(Collection<String> variableNames)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariableInstances(Collection), but only for variables local to this scope.
    
    Specified by:
    
    getVariableInstancesLocal in interface VariableScope
  - getVariablesLocal
```
public Map<String,Object> getVariablesLocal(Collection<String> variableNames,
                                            boolean fetchAllVariables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariables(Collection, boolean), but only for variables local to this scope.
    
    Specified by:
    
    getVariablesLocal in interface VariableScope
  - getVariableInstancesLocal
```
public Map<String,VariableInstance> getVariableInstancesLocal(Collection<String> variableNames,
                                                              boolean fetchAllVariables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariableInstances(Collection, boolean), but only for variables local to this scope.
    
    Specified by:
    
    getVariableInstancesLocal in interface VariableScope
  - getSpecificVariables
```
protected abstract List<VariableInstanceEntity> getSpecificVariables(Collection<String> variableNames)
```
  - getVariableNamesLocal
```
public Set<String> getVariableNamesLocal()
```
    Description copied from interface: VariableScope
    
    Returns all the names of the variables for this scope (no parent scopes).
    
    Specified by:
    
    getVariableNamesLocal in interface VariableScope
  - getVariableInstanceEntities
```
public Map<String,VariableInstanceEntity> getVariableInstanceEntities()
```
  - getUsedVariablesCache
```
public Map<String,VariableInstanceEntity> getUsedVariablesCache()
```
  - createVariablesLocal
```
public void createVariablesLocal(Map<String,? extends Object> variables)
```
  - setVariables
```
public void setVariables(Map<String,? extends Object> variables)
```
    Description copied from interface: VariableScope
    
    Sets the provided variables to the variable scope.
    Variables are set according algorithm for VariableScope.setVariable(String, Object), applied separately to each variable.
    
    Specified by:
    
    setVariables in interface VariableScope
    
    Parameters:
    
    variables - a map of keys and values for the variables to be set
  - setVariablesLocal
```
public void setVariablesLocal(Map<String,? extends Object> variables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.setVariables(Map), but the variable are set on this scope specifically.
    
    Specified by:
    
    setVariablesLocal in interface VariableScope
  - removeVariables
```
public void removeVariables()
```
    Description copied from interface: VariableScope
    
    Removes the (local) variables and creates a new HistoricVariableUpdate for each of them.
    
    Specified by:
    
    removeVariables in interface VariableScope
  - removeVariablesLocal
```
public void removeVariablesLocal()
```
    Description copied from interface: VariableScope
    
    Removes the (local) variables and creates a new HistoricVariableUpdate for each of them.
    
    Specified by:
    
    removeVariablesLocal in interface VariableScope
  - removeVariables
```
public void removeVariables(Collection<String> variableNames)
```
    Description copied from interface: VariableScope
    
    Removes the variables and creates a new HistoricVariableUpdate for each of them.
    
    Specified by:
    
    removeVariables in interface VariableScope
  - removeVariablesLocal
```
public void removeVariablesLocal(Collection<String> variableNames)
```
    Description copied from interface: VariableScope
    
    Removes the local variables and creates a new HistoricVariableUpdate for each of them.
    
    Specified by:
    
    removeVariablesLocal in interface VariableScope
  - setVariable
```
public void setVariable(String variableName,
                        Object value)
```
    Description copied from interface: VariableScope
    Sets the variable with the provided name to the provided value. In the case when variable name is an expression which is resolved by expression manager, the value is set in the object resolved from the expression.
    A variable is set according to the following algorithm:
    - If variable name is an expression, resolve expression and set the value on the resolved object.
    - If this scope already contains a variable by the provided name as a local variable, its value is overwritten to the provided value.
    - If this scope does not contain a variable by the provided name as a local variable, the variable is set to this scope's parent scope, if there is one. If there is no parent scope (meaning this scope is the root scope of the hierarchy it belongs to), this scope is used. This applies recursively up the parent scope chain until, if no scope contains a local variable by the provided name, ultimately the root scope is reached and the variable value is set on that scope.
    In practice for most cases, this algorithm will set variables to the scope of the execution at the process instance’s root level, if there is no execution-local variable by the provided name.
    Specified by:
    
    setVariable in interface VariableContainer
    
    Specified by:
    
    setVariable in interface VariableScope
    
    Parameters:
    
    variableName - the name of the variable to be set
    
    value - the value of the variable to be set
  - setVariable
```
public void setVariable(String variableName,
                        Object value,
                        boolean fetchAllVariables)
```
    The default setVariable(String, Object) fetches all variables (for historical and backwards compatible reasons) while setting the variables. Setting the fetchAllVariables parameter to true is the default behaviour (ie fetching all variables) Setting the fetchAllVariables parameter to false does not do that.
    
    Specified by:
    
    setVariable in interface VariableScope
  - setVariableLocal
```
public Object setVariableLocal(String variableName,
                               Object value)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.setVariable(String, Object), but the variable is set to this scope specifically. Variable name is handled as a variable name string without resolving an expression.
    
    Specified by:
    
    setVariableLocal in interface VariableScope
  - setVariableLocal
```
public Object setVariableLocal(String variableName,
                               Object value,
                               boolean fetchAllVariables)
```
    The default setVariableLocal(String, Object) fetches all variables (for historical and backwards compatible reasons) while setting the variables. Setting the fetchAllVariables parameter to true is the default behaviour (ie fetching all variables) Setting the fetchAllVariables parameter to false does not do that.
    
    Specified by:
    
    setVariableLocal in interface VariableScope
  - createVariableLocal
```
protected void createVariableLocal(String variableName,
                                   Object value)
```
    only called when a new variable is created on this variable scope. This method is also responsible for propagating the creation of this variable to the history.
  - removeVariable
```
public void removeVariable(String variableName)
```
    Description copied from interface: VariableScope
    
    Removes the variable and creates a new HistoricVariableUpdate.
    
    Specified by:
    
    removeVariable in interface VariableScope
  - removeVariableLocal
```
public void removeVariableLocal(String variableName)
```
    Description copied from interface: VariableScope
    
    Removes the local variable and creates a new HistoricVariableUpdate.
    
    Specified by:
    
    removeVariableLocal in interface VariableScope
  - deleteVariableInstanceForExplicitUserCall
```
protected void deleteVariableInstanceForExplicitUserCall(VariableInstanceEntity variableInstance)
```
  - updateVariableInstance
```
protected void updateVariableInstance(VariableInstanceEntity variableInstance,
                                      Object value)
```
  - createVariableInstance
```
protected VariableInstanceEntity createVariableInstance(String variableName,
                                                        Object value)
```
  - storeVariableLocal
```
protected boolean storeVariableLocal(String variableName)
```
  - setTransientVariablesLocal
```
public void setTransientVariablesLocal(Map<String,Object> transientVariables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.setVariablesLocal(Map), but for transient variables. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    setTransientVariablesLocal in interface VariableScope
  - setTransientVariableLocal
```
public void setTransientVariableLocal(String variableName,
                                      Object variableValue)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.setVariableLocal(String, Object), but for a transient variable. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    setTransientVariableLocal in interface VariableScope
  - setTransientVariables
```
public void setTransientVariables(Map<String,Object> transientVariables)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.setVariables(Map), but for transient variables. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    setTransientVariables in interface VariableScope
  - setTransientVariable
```
public void setTransientVariable(String variableName,
                                 Object variableValue)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.setVariable(String, Object), but the variable is transient: - no history is kept for the variable - the variable is only available until a waitstate is reached in the process - transient variables 'shadow' persistent variable (when getVariable('abc') where 'abc' is both persistent and transient, the transient value is returned.
    
    Specified by:
    
    setTransientVariable in interface VariableContainer
    
    Specified by:
    
    setTransientVariable in interface VariableScope
  - getTransientVariableLocal
```
public Object getTransientVariableLocal(String variableName)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariableLocal(String), but for a transient variable. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    getTransientVariableLocal in interface VariableScope
  - getTransientVariablesLocal
```
public Map<String,Object> getTransientVariablesLocal()
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariableLocal(String), but for transient variables only. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    getTransientVariablesLocal in interface VariableScope
  - getTransientVariable
```
public Object getTransientVariable(String variableName)
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariable(String), including the searching via the parent scopes, but for transient variables only. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    getTransientVariable in interface VariableScope
  - getTransientVariables
```
public Map<String,Object> getTransientVariables()
```
    Description copied from interface: VariableScope
    
    Similar to VariableScope.getVariables(), but for transient variables only. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    getTransientVariables in interface VariableScope
  - collectTransientVariables
```
protected Map<String,Object> collectTransientVariables(HashMap<String,Object> variables)
```
  - removeTransientVariableLocal
```
public void removeTransientVariableLocal(String variableName)
```
    Description copied from interface: VariableScope
    
    Removes a specific transient variable (also searching parent scopes). See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    removeTransientVariableLocal in interface VariableScope
  - removeTransientVariablesLocal
```
public void removeTransientVariablesLocal()
```
    Description copied from interface: VariableScope
    
    Removes all local transient variables. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    removeTransientVariablesLocal in interface VariableScope
  - removeTransientVariable
```
public void removeTransientVariable(String variableName)
```
    Description copied from interface: VariableScope
    
    Removes a specific transient variable. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    removeTransientVariable in interface VariableScope
  - removeTransientVariables
```
public void removeTransientVariables()
```
    Description copied from interface: VariableScope
    
    Remove all transient variable of this scope and its parent scopes. See VariableScope.setTransientVariable(String, Object) for the rules on 'transient' variables.
    
    Specified by:
    
    removeTransientVariables in interface VariableScope
  - isPropagateToHistoricVariable
```
protected abstract boolean isPropagateToHistoricVariable()
```
    Return whether changes to the variables are propagated to the history storage.
  - getVariableServiceConfiguration
```
protected abstract VariableServiceConfiguration getVariableServiceConfiguration()
```
  - getCachedElContext
```
public ELContext getCachedElContext()
```
  - setCachedElContext
```
public void setCachedElContext(ELContext cachedElContext)
```
  - getVariable
```
public <T> T getVariable(String variableName,
                         Class<T> variableClass)
```
    Description copied from interface: VariableScope
    
    Typed version of the VariableScope.getVariable(String) method.
    
    Specified by:
    
    getVariable in interface VariableScope
  - getVariableLocal
```
public <T> T getVariableLocal(String variableName,
                              Class<T> variableClass)
```
    Description copied from interface: VariableScope
    
    Typed version of the VariableScope.getVariableLocal(String) method.
    
    Specified by:
    
    getVariableLocal in interface VariableScope
  - isExpression
```
protected boolean isExpression(String variableName)
```

Class VariableScopeImpl

Field Summary

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

Constructor Summary

Method Summary

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

Methods inherited from class java.lang.Object

Methods inherited from interface org.flowable.common.engine.api.variable.VariableContainer

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

Field Detail

variableInstances

usedVariablesCache

transientVariables

cachedElContext

Constructor Detail

VariableScopeImpl

Method Detail

loadVariableInstances

getParentVariableScope

initializeVariableInstanceBackPointer

addLoggingSessionInfo

ensureVariableInstancesInitialized

internalSetVariableInstances

getVariables

getVariableInstances

getVariables

getVariableInstances

getVariables

getVariableInstances

collectVariables

collectVariableInstances

getVariable

getVariableInstance

getVariable

getVariableInstance

getSpecificVariable

getVariableLocal

getVariableInstanceLocal

getVariableLocal

getVariableInstanceLocal

hasVariables

hasVariablesLocal

hasVariable

hasVariableLocal

collectVariableNames

getVariableNames

getVariablesLocal

getVariableInstancesLocal

getVariablesLocal

getVariableInstancesLocal

getVariablesLocal

getVariableInstancesLocal

getSpecificVariables

getVariableNamesLocal

getVariableInstanceEntities

getUsedVariablesCache

createVariablesLocal

setVariables

setVariablesLocal

removeVariables

removeVariablesLocal

removeVariables

removeVariablesLocal

setVariable

setVariable

setVariableLocal

setVariableLocal

createVariableLocal

removeVariable

removeVariableLocal

deleteVariableInstanceForExplicitUserCall

updateVariableInstance

createVariableInstance

storeVariableLocal

setTransientVariablesLocal

setTransientVariableLocal

setTransientVariables

setTransientVariable

getTransientVariableLocal

getTransientVariablesLocal