com.sun.n1.sps.model.component
Interface ComponentVariableSettings

public interface ComponentVariableSettings

Contains the override variables settings associated with a particular component. Note that only publicly accessible, non-final local and inherited variables in the associated component may be overridden. Furthermore, it is not possible to create override variable settings on abstract and non-public components.

Method Summary

boolean	containsOverrideVarValue(java.lang.String varName) Returns true if there is an override value defined for the passed variable name, false otherwise.
boolean	containsVarValue(java.lang.String varName) Returns true if there is either an override or a default value defined for the passed variable name, false otherwise.
ComponentVariableSettingsID	getID() Returns the ID of this object.
java.lang.String	getName() Returns the name of this object.
java.lang.String[]	getOverrideVarNames() Returns the names of all variables overridden by this object.
java.lang.String	getOverrideVarValue(java.lang.String varName) Returns the override value for the passed variable name.
java.lang.String[]	getVarNames() Returns the names of all accessible variables, as defined by the associated component.
java.lang.String	getVarValue(java.lang.String varName) Returns the value of the passed variable name.
boolean	isReadOnlyVar(java.lang.String varName) Returns true if the named variable is read only, false otherwise.

Method Detail

getID

ComponentVariableSettingsID getID()

Returns the ID of this object. This value is null if the object has not been previously saved.

Returns:

the ID

getName

java.lang.String getName()

Returns the name of this object.

Returns:

the name.

getOverrideVarValue

java.lang.String getOverrideVarValue(java.lang.String varName)

Returns the override value for the passed variable name. If this object does not define an override value, null is returned.

Parameters:

varName - the name of the variable to look up.

Returns:

the override value for the passed variable name.

getOverrideVarNames

java.lang.String[] getOverrideVarNames()

Returns the names of all variables overridden by this object. The names returned are guaranteed to be a subset of the names declared in the associated component. Modifications to the list of variables do not affect this object.

Returns:

the override names.

containsOverrideVarValue

boolean containsOverrideVarValue(java.lang.String varName)

Returns true if there is an override value defined for the passed variable name, false otherwise.

Parameters:

varName - the name of the variable to look up.

Returns:

true if an override value is defined, false otherwise.

getVarValue

java.lang.String getVarValue(java.lang.String varName)

Returns the value of the passed variable name. If an override value is defined locally, it is returned. Otherwise the default value defined by the associated component is returned. If the component does not define a value either, null is returned.

Parameters:

varName - the name of the variable to look up.

Returns:

the value for the passed variable name.

getVarNames

java.lang.String[] getVarNames()

Returns the names of all accessible variables, as defined by the associated component. Note that the variable names returned will include read only variables. The client must ensure that read-only variables are not overridden. Modifications to the list of variables do not affect this object.

Returns:

the names.

containsVarValue

boolean containsVarValue(java.lang.String varName)

Returns true if there is either an override or a default value defined for the passed variable name, false otherwise.

Parameters:

varName - the name of the variable to look up.

Returns:

true if an override or default value is defined, false otherwise.

isReadOnlyVar

boolean isReadOnlyVar(java.lang.String varName)

Returns true if the named variable is read only, false otherwise. Variables that are read only may not be overridden by this object, but may be referenced in the values of other variables that are not read only. Note that if the passed variable is unknown, false is returned.

Parameters:

varName - the name of the variable to look up.

Returns:

true if the variable is read only, false otherwise.