oracle.jbo

Interface VariableValueManager

All Superinterfaces:

VariableManager

All Known Implementing Classes:

ClientVariableValueManager, DCVariableValueManagerImpl, VariableValueManagerImpl

public interface VariableValueManager
extends VariableManager

Manages named variables and their values.

Since:

JDeveloper 10.1.3

Method Summary

Modifier and Type	Method and Description
void	activatePassivatedVariables(java.lang.String passivatedString) Deprecated. Replaced by readVarsFromXML(org.w3c.dom.Element)
java.lang.Object	clearValue(java.lang.String name) Revert the value of the variable back to it's default.
java.lang.Object	clearValue(Variable var) Revert the value of the variable back to it's default.
java.lang.String	getLocalPassivatableVariables() Deprecated. Replaced by writeVarsToXML(Document, Element, boolean)
java.lang.String	getPassivatableVariables() Deprecated. Replaced by writeVarsToXML(Document, Element, boolean)
java.lang.Object	getVariableValue(java.lang.String name)
java.lang.Object	getVariableValue(Variable var)
java.lang.Object	getVariableValueRaw(java.lang.String name, boolean evaluateDefaultOrExpr)
java.lang.Object	getVariableValueRaw(Variable var, boolean evaluateDefaultOrExpr)
java.lang.Object[]	getVariableValues(Variable[] vars)
java.lang.Object[]	getVariableValuesRaw(Variable[] vars, boolean evaluateDefaultOrExpr)
boolean	hasVariableValue(java.lang.String name)
boolean	hasVariableValue(Variable var)
void	mergeVariableValues(Variable[] vars, java.lang.Object[] varVals)
void	readVarsFromXML(org.w3c.dom.Element varsElem) Reads all the variables from the XML element and sets them into this variable manager.
void	setVariableValue(java.lang.String name, java.lang.Object value)
void	setVariableValue(Variable var, java.lang.Object value)
void	setVariableValues(Variable[] vars, java.lang.Object[] varVals)
void	setVariableValuesFrom(VariableValueManager vm)
boolean	writeVarsToXML(org.w3c.dom.Document xmlDoc, org.w3c.dom.Element parent, boolean local) Writes XML elements for all variables in this variable manager and appends them to the given parent node.

Methods inherited from interface oracle.jbo.VariableManager

addVariable, addVariable, addVariables, clearVariables, findDeclaredVariable, findVariable, getDeclaredVariableCount, getDeclaredVariables, getName, getVariableCount, getVariables, getVariablesMap, getVariablesOfKind, getVarMgrOwner, getVarMgrOwnerBase, getVarMgrParents, lookupVariable, mergeVariables, removeVariable, replaceVariable, variableChanged

Method Detail

hasVariableValue

boolean hasVariableValue(Variable var)

hasVariableValue

boolean hasVariableValue(java.lang.String name)

getVariableValue

java.lang.Object getVariableValue(Variable var)

getVariableValue

java.lang.Object getVariableValue(java.lang.String name)

getVariableValueRaw

java.lang.Object getVariableValueRaw(Variable var,
                                     boolean evaluateDefaultOrExpr)

getVariableValueRaw

java.lang.Object getVariableValueRaw(java.lang.String name,
                                     boolean evaluateDefaultOrExpr)

getVariableValues

java.lang.Object[] getVariableValues(Variable[] vars)

getVariableValuesRaw

java.lang.Object[] getVariableValuesRaw(Variable[] vars,
                                        boolean evaluateDefaultOrExpr)

setVariableValue

void setVariableValue(Variable var,
                      java.lang.Object value)

setVariableValue

void setVariableValue(java.lang.String name,
                      java.lang.Object value)

setVariableValues

void setVariableValues(Variable[] vars,
                       java.lang.Object[] varVals)

setVariableValuesFrom

void setVariableValuesFrom(VariableValueManager vm)

mergeVariableValues

void mergeVariableValues(Variable[] vars,
                         java.lang.Object[] varVals)

clearValue

java.lang.Object clearValue(java.lang.String name)

Revert the value of the variable back to it's default.

Returns:

the existing value (may be null)

Throws:

NoDefException - if the name doesn't refer to an existing variable

clearValue

java.lang.Object clearValue(Variable var)

Revert the value of the variable back to it's default.

Returns:

the existing value (may be null)

getPassivatableVariables

@Deprecated
java.lang.String getPassivatableVariables()

Deprecated. Replaced by writeVarsToXML(Document, Element, boolean)

Used internally by the framework to gather up all variable state that isn't reconstructed by simply resetting from definitions.

getLocalPassivatableVariables

@Deprecated
java.lang.String getLocalPassivatableVariables()

Deprecated. Replaced by writeVarsToXML(Document, Element, boolean)

Used internally by the framework to gather up all variable state that isn't reconstructed by simply resetting from definitions. Doesn't recurse the parent variable managers.

activatePassivatedVariables

@Deprecated
void activatePassivatedVariables(java.lang.String passivatedString)

Deprecated. Replaced by readVarsFromXML(org.w3c.dom.Element)

Used internally by the framework to reinstate the passivation image without causing any ripples in either the validation or notifications.

writeVarsToXML

boolean writeVarsToXML(org.w3c.dom.Document xmlDoc,
                       org.w3c.dom.Element parent,
                       boolean local)

Writes XML elements for all variables in this variable manager and appends them to the given parent node. Used internally by the framework to gather up all variable state that isn't reconstructed by simply resetting from definitions.

Parameters:

xmlDoc - the XML document in which the variables should be passivated

parent - the enclosing XML node where new nodes will be appended

local - if true do not recurse the parent variable managers

Returns:

true if variable nodes were appended to the parent node.

See Also:

readVarsFromXML(Element)

readVarsFromXML

void readVarsFromXML(org.w3c.dom.Element varsElem)

Reads all the variables from the XML element and sets them into this variable manager. Used internally by the framework to reinstate the passivation image without causing any ripples in either the validation or notifications.

Parameters:

varsElem - an XML node containing the passivated variables

See Also:

writeVarsToXML(Document, Element, boolean)