org.camunda.bpm.engine.delegate
Interface VariableScope<T extends CoreVariableInstance>

All Known Subinterfaces:

ActivityExecution, BaseDelegateExecution, CmmnActivityExecution, CmmnCaseInstance, DelegateCaseExecution, DelegateExecution, DelegateTask, PersistentVariableScope

All Known Implementing Classes:

CaseExecutionEntity, CaseExecutionImpl, CmmnExecution, ConnectorVariableScope, CoreExecution, CorePersistentVariableScope, CoreVariableScope, ExecutionEntity, ExecutionImpl, PvmExecutionImpl, StartProcessVariableScope, TaskEntity

public interface VariableScope<T extends CoreVariableInstance>

Author:

Tom Baeyens

Method Summary

Object	getVariable(String variableName)
T	getVariableInstance(String name) Returns a single variable instance from either this scope or any of its parents.
T	getVariableInstanceLocal(String name) Returns a single variable instance that this scope holds.
Map<String,T>	getVariableInstances() Returns this scope's and its parent's (grandparents etc.) variables as variable instance objects.
Map<String,T>	getVariableInstancesLocal() Returns the variable instances that this scope holds.
Object	getVariableLocal(String variableName)
Set<String>	getVariableNames()
Set<String>	getVariableNamesLocal()
Map<String,Object>	getVariables()
Map<String,Object>	getVariablesLocal()
boolean	hasVariable(String variableName)
boolean	hasVariableLocal(String variableName)
boolean	hasVariables()
boolean	hasVariablesLocal()
void	removeVariable(String variableName) Removes the variable and creates a new HistoricVariableUpdateEntity.
void	removeVariableLocal(String variableName) Removes the local variable and creates a new HistoricVariableUpdateEntity.
void	removeVariables() Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariables(Collection<String> variableNames) Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariablesLocal() Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.
void	removeVariablesLocal(Collection<String> variableNames) Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.
void	setVariable(String variableName, Object value)
void	setVariableLocal(String variableName, Object value)
void	setVariables(Map<String,? extends Object> variables)
void	setVariablesLocal(Map<String,? extends Object> variables)

Method Detail

getVariables

Map<String,Object> getVariables()

getVariablesLocal

Map<String,Object> getVariablesLocal()

getVariable

Object getVariable(String variableName)

getVariableLocal

Object getVariableLocal(String variableName)

getVariableNames

Set<String> getVariableNames()

getVariableNamesLocal

Set<String> getVariableNamesLocal()

setVariable

void setVariable(String variableName,
                 Object value)

setVariableLocal

void setVariableLocal(String variableName,
                      Object value)

setVariables

void setVariables(Map<String,? extends Object> variables)

setVariablesLocal

void setVariablesLocal(Map<String,? extends Object> variables)

hasVariables

boolean hasVariables()

hasVariablesLocal

boolean hasVariablesLocal()

hasVariable

boolean hasVariable(String variableName)

hasVariableLocal

boolean hasVariableLocal(String variableName)

removeVariable

void removeVariable(String variableName)

Removes the variable and creates a new HistoricVariableUpdateEntity.

removeVariableLocal

void removeVariableLocal(String variableName)

Removes the local variable and creates a new HistoricVariableUpdateEntity.

removeVariables

void removeVariables(Collection<String> variableNames)

Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.

removeVariablesLocal

void removeVariablesLocal(Collection<String> variableNames)

Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.

removeVariables

void removeVariables()

Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

removeVariablesLocal

void removeVariablesLocal()

Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

getVariableInstances

Map<String,T> getVariableInstances()

Returns this scope's and its parent's (grandparents etc.) variables as variable instance objects.

getVariableInstance

T getVariableInstance(String name)

Returns a single variable instance from either this scope or any of its parents.

getVariableInstancesLocal

Map<String,T> getVariableInstancesLocal()

Returns the variable instances that this scope holds.

getVariableInstanceLocal

T getVariableInstanceLocal(String name)

Returns a single variable instance that this scope holds.