com.bowstreet.webapp
Interface Variables

All Superinterfaces:

IDataAccess

public interface Variables
extends IDataAccess

Interface to access WebApp Variables.

Method Summary

Variable	addLinkedObjectVariable(java.lang.String name, java.lang.String className) Add a Java Object variable to the list.
Variable	addVariable(java.lang.String name, java.lang.String type) Add a variable to the list.
Variable	getVariable(java.lang.String name) Gets the specified Variable by name as a Variable.
java.lang.String	getXmlChildText(java.lang.String name, java.lang.String elementName) This will get the text value of the child element from the specified variable.
IXml	getXmlElement(java.lang.String name, java.lang.String path) This will get the IXml element from the specified variable and path.
java.lang.String	getXmlText(java.lang.String name, java.lang.String path) This will get the text value of the element from the specified variable and path.

Methods inherited from interface com.bowstreet.util.IDataAccess

getBoolean, getDouble, getFloat, getInt, getIterator, getLong, getObject, getString, getXml, setBoolean, setDouble, setFloat, setInt, setLong, setObject, setString, setXml

Method Detail

addLinkedObjectVariable

Variable addLinkedObjectVariable(java.lang.String name,
                                 java.lang.String className)

Add a Java Object variable to the list.

Parameters:

name - The name for the variable

className - The Java class for the variable

Returns:

The ObjectVariable object

addVariable

Variable addVariable(java.lang.String name,
                     java.lang.String type)

Add a variable to the list.

Parameters:

name - The name for the variable

type - The type for the variable (e.g. Variable.TYPE_STRING)

Returns:

The Variable object

getVariable

Variable getVariable(java.lang.String name)

Gets the specified Variable by name as a Variable.

Parameters:

name - The name of the Variable to get.

Returns:

the Variable

See Also:

Variable

getXmlChildText

java.lang.String getXmlChildText(java.lang.String name,
                                 java.lang.String elementName)

This will get the text value of the child element from the specified variable.
The specified element name must be a direct child of the xml variable root element.

Parameters:

name - The name of the variable.

elementName - The child element name to get the text value from.

Returns:

The text value of the specified element or null if not found.

getXmlElement

IXml getXmlElement(java.lang.String name,
                   java.lang.String path)

This will get the IXml element from the specified variable and path.

Parameters:

name - The name of the variable

path - The path of the element to get.

Returns:

The element at the specified path or null if not found.

See Also:

findElement

getXmlText

java.lang.String getXmlText(java.lang.String name,
                            java.lang.String path)

This will get the text value of the element from the specified variable and path.

Parameters:

name - The name of the variable.

path - The path of the element to get the text value from.

Returns:

The text value of the specified element or null if not found.

See Also:

getValueOf