org.camunda.bpm.engine.impl.el
Class StartProcessVariableScope

java.lang.Object
  extended by org.camunda.bpm.engine.impl.el.StartProcessVariableScope
All Implemented Interfaces:
VariableScope<CoreVariableInstance>

public class StartProcessVariableScope
extends Object
implements VariableScope<CoreVariableInstance>

Variable-scope only used to resolve variables when NO execution is active but expression-resolving is needed. This occurs eg. when start-form properties have default's defined. Even though variables are not available yet, expressions should be resolved anyway.

Author:
Frederik Heremans

Constructor Summary
StartProcessVariableScope()
           
 
Method Summary
static StartProcessVariableScope getSharedInstance()
          Since a StartProcessVariableScope has no state, it's safe to use the same instance to prevent too many useless instances created.
 Object getVariable(String variableName)
           
 CoreVariableInstance getVariableInstance(String name)
          Returns a single variable instance from either this scope or any of its parents.
 CoreVariableInstance getVariableInstanceLocal(String name)
          Returns a single variable instance that this scope holds.
 Map<String,CoreVariableInstance> getVariableInstances()
          Returns this scope's and its parent's (grandparents etc.) variables as variable instance objects.
 Map<String,CoreVariableInstance> 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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StartProcessVariableScope

public StartProcessVariableScope()
Method Detail

getSharedInstance

public static StartProcessVariableScope getSharedInstance()
Since a StartProcessVariableScope has no state, it's safe to use the same instance to prevent too many useless instances created.


getVariables

public Map<String,Object> getVariables()
Specified by:
getVariables in interface VariableScope<CoreVariableInstance>

getVariablesLocal

public Map<String,Object> getVariablesLocal()
Specified by:
getVariablesLocal in interface VariableScope<CoreVariableInstance>

getVariable

public Object getVariable(String variableName)
Specified by:
getVariable in interface VariableScope<CoreVariableInstance>

getVariableLocal

public Object getVariableLocal(String variableName)
Specified by:
getVariableLocal in interface VariableScope<CoreVariableInstance>

getVariableNames

public Set<String> getVariableNames()
Specified by:
getVariableNames in interface VariableScope<CoreVariableInstance>

getVariableNamesLocal

public Set<String> getVariableNamesLocal()
Specified by:
getVariableNamesLocal in interface VariableScope<CoreVariableInstance>

setVariable

public void setVariable(String variableName,
                        Object value)
Specified by:
setVariable in interface VariableScope<CoreVariableInstance>

setVariableLocal

public void setVariableLocal(String variableName,
                             Object value)
Specified by:
setVariableLocal in interface VariableScope<CoreVariableInstance>

setVariables

public void setVariables(Map<String,? extends Object> variables)
Specified by:
setVariables in interface VariableScope<CoreVariableInstance>

setVariablesLocal

public void setVariablesLocal(Map<String,? extends Object> variables)
Specified by:
setVariablesLocal in interface VariableScope<CoreVariableInstance>

hasVariables

public boolean hasVariables()
Specified by:
hasVariables in interface VariableScope<CoreVariableInstance>

hasVariablesLocal

public boolean hasVariablesLocal()
Specified by:
hasVariablesLocal in interface VariableScope<CoreVariableInstance>

hasVariable

public boolean hasVariable(String variableName)
Specified by:
hasVariable in interface VariableScope<CoreVariableInstance>

hasVariableLocal

public boolean hasVariableLocal(String variableName)
Specified by:
hasVariableLocal in interface VariableScope<CoreVariableInstance>

removeVariable

public void removeVariable(String variableName)
Description copied from interface: VariableScope
Removes the variable and creates a new HistoricVariableUpdateEntity.

Specified by:
removeVariable in interface VariableScope<CoreVariableInstance>

removeVariableLocal

public void removeVariableLocal(String variableName)
Description copied from interface: VariableScope
Removes the local variable and creates a new HistoricVariableUpdateEntity.

Specified by:
removeVariableLocal in interface VariableScope<CoreVariableInstance>

removeVariables

public void removeVariables()
Description copied from interface: VariableScope
Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:
removeVariables in interface VariableScope<CoreVariableInstance>

removeVariablesLocal

public void removeVariablesLocal()
Description copied from interface: VariableScope
Removes the (local) variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:
removeVariablesLocal in interface VariableScope<CoreVariableInstance>

removeVariables

public void removeVariables(Collection<String> variableNames)
Description copied from interface: VariableScope
Removes the variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:
removeVariables in interface VariableScope<CoreVariableInstance>

removeVariablesLocal

public void removeVariablesLocal(Collection<String> variableNames)
Description copied from interface: VariableScope
Removes the local variables and creates a new HistoricVariableUpdateEntity for each of them.

Specified by:
removeVariablesLocal in interface VariableScope<CoreVariableInstance>

getVariableInstances

public Map<String,CoreVariableInstance> getVariableInstances()
Description copied from interface: VariableScope
Returns this scope's and its parent's (grandparents etc.) variables as variable instance objects.

Specified by:
getVariableInstances in interface VariableScope<CoreVariableInstance>

getVariableInstance

public CoreVariableInstance getVariableInstance(String name)
Description copied from interface: VariableScope
Returns a single variable instance from either this scope or any of its parents.

Specified by:
getVariableInstance in interface VariableScope<CoreVariableInstance>

getVariableInstancesLocal

public Map<String,CoreVariableInstance> getVariableInstancesLocal()
Description copied from interface: VariableScope
Returns the variable instances that this scope holds.

Specified by:
getVariableInstancesLocal in interface VariableScope<CoreVariableInstance>

getVariableInstanceLocal

public CoreVariableInstance getVariableInstanceLocal(String name)
Description copied from interface: VariableScope
Returns a single variable instance that this scope holds.

Specified by:
getVariableInstanceLocal in interface VariableScope<CoreVariableInstance>


Copyright © 2014 camunda services GmbH. All Rights Reserved.