org.jvoicexml.xml.vxml

Class Return

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Return

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Return
extends AbstractXmlNode

<return> ends execution of a subdialog and returns control and data to a calling dialog.

See Also:

Exit

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_EVENT Return, then throw this event.
static java.lang.String	ATTRIBUTE_EVENTEXPR Return, then throw the event to which this ECMAScript expression evaluates.
static java.lang.String	ATTRIBUTE_MESSAGE A message string providing additional context about the event being thrown.
static java.lang.String	ATTRIBUTE_MESSAGEEXPR An ECMAScript expression evaluating to the message string.
static java.lang.String	ATTRIBUTE_NAMELIST Variable names to be returned to calling dialog.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	TAG_NAME Name of the tag.

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor and Description
Return() Construct a new return object without a node.

Method Summary

Modifier and Type	Method and Description
protected boolean	canContainChild(java.lang.String tagName) Can the specified sub-tag be contained within this node?
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getEvent() Retrieve the event attribute.
java.lang.String	getEventexpr() Retrieve the eventexpr attribute.
java.lang.String	getMessage() Retrieve the message attribute.
java.lang.String	getMessageexpr() Retrieve the messageexpr attribute.
java.lang.String	getNamelist() Retrieve the namelist attribute.
TokenList	getNameListObject() Retrieve the namelist attribute as a list object.
java.lang.String	getTagName() Get the name of the tag for the derived node.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setEvent(java.lang.String event) Set the event attribute.
void	setEventexpr(java.lang.String eventexpr) Set the eventexpr attribute.
void	setMessage(java.lang.String message) Set the message attribute.
void	setMessageexpr(java.lang.String messageexpr) Set the messageexpr attribute.
void	setNamelist(java.lang.String namelist) Set the namelist attribute.
void	setNameList(TokenList list) Set the namelist attribute.

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

addChild, addChild, appendChild, appendChild, appendDeepClone, cloneNode, compareDocumentPosition, equals, getAttribute, getAttributes, getBaseURI, getChildNodes, getChildNodes, getChildren, getDefinedAttributeNames, getFeature, getFirstChild, getFirstLevelTextContent, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeFactory, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerXmlDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttribute, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jvoicexml.xml.XmlNode

addChild, getAttribute, getChildNodes, getChildren, getNode, setAttribute

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_EVENT

public static final java.lang.String ATTRIBUTE_EVENT

Return, then throw this event.

See Also:

Constant Field Values

ATTRIBUTE_EVENTEXPR

public static final java.lang.String ATTRIBUTE_EVENTEXPR

Return, then throw the event to which this ECMAScript expression evaluates.

See Also:

Constant Field Values

ATTRIBUTE_MESSAGE

public static final java.lang.String ATTRIBUTE_MESSAGE

A message string providing additional context about the event being thrown. The message is available as the value of a variable within the scope of the catch element.

See Also:

Constant Field Values

ATTRIBUTE_MESSAGEEXPR

public static final java.lang.String ATTRIBUTE_MESSAGEEXPR

An ECMAScript expression evaluating to the message string.

See Also:

Constant Field Values

ATTRIBUTE_NAMELIST

public static final java.lang.String ATTRIBUTE_NAMELIST

Variable names to be returned to calling dialog. The default is to return no variables; this means the caller will receive an empty ECMAScript object. If an undeclared variable is referenced in the namelist, then an error.semantic is thrown.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Return

public Return()

Construct a new return object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Method Detail

getTagName

public java.lang.String getTagName()

Get the name of the tag for the derived node.

Returns:

name of the tag.

newInstance

public XmlNode newInstance(org.w3c.dom.Node n,
                           XmlNodeFactory<? extends XmlNode> factory)

Create a new instance for the given node.

Each XmlNode can serve as a prototype in a XmlNodeFactory to produce a collection of child nodes. Factories can then use the prototype pattern to produce new nodes.

Parameters:

n - The node to encapsulate.

factory - the factroy that calls this method.

Returns:

The new instance.

See Also:

XmlNodeFactory

getEvent

public java.lang.String getEvent()

Retrieve the event attribute.

Returns:

Value of the event attribute.

See Also:

ATTRIBUTE_EVENT

setEvent

public void setEvent(java.lang.String event)

Set the event attribute.

Parameters:

event - Value of the event attribute.

See Also:

ATTRIBUTE_EVENT

getEventexpr

public java.lang.String getEventexpr()

Retrieve the eventexpr attribute.

Returns:

Value of the eventexpr attribute.

See Also:

ATTRIBUTE_EVENTEXPR

setEventexpr

public void setEventexpr(java.lang.String eventexpr)

Set the eventexpr attribute.

Parameters:

eventexpr - Value of the eventexpr attribute.

See Also:

ATTRIBUTE_EVENTEXPR

getMessage

public java.lang.String getMessage()

Retrieve the message attribute.

Returns:

Value of the message attribute.

See Also:

ATTRIBUTE_MESSAGE

setMessage

public void setMessage(java.lang.String message)

Set the message attribute.

Parameters:

message - Value of the message attribute.

See Also:

ATTRIBUTE_MESSAGE

getMessageexpr

public java.lang.String getMessageexpr()

Retrieve the messageexpr attribute.

Returns:

Value of the messageexpr attribute.

See Also:

ATTRIBUTE_MESSAGEEXPR

setMessageexpr

public void setMessageexpr(java.lang.String messageexpr)

Set the messageexpr attribute.

Parameters:

messageexpr - Value of the messageexpr attribute.

See Also:

ATTRIBUTE_MESSAGEEXPR

getNamelist

public java.lang.String getNamelist()

Retrieve the namelist attribute.

Returns:

Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

getNameListObject

public TokenList getNameListObject()

Retrieve the namelist attribute as a list object.

Returns:

Value of the namelist attribute as a list.

Since:

0.3

See Also:

getNamelist()

setNamelist

public void setNamelist(java.lang.String namelist)

Set the namelist attribute.

Parameters:

namelist - Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

setNameList

public void setNameList(TokenList list)

Set the namelist attribute.

Parameters:

list - Value of the namelist attribute.

Since:

0.7.4

See Also:

ATTRIBUTE_NAMELIST, setNamelist(String)

canContainChild

protected boolean canContainChild(java.lang.String tagName)

Can the specified sub-tag be contained within this node?

Specified by:

canContainChild in class AbstractXmlNode

Parameters:

tagName - Name of child.

Returns:

True if the sub-tag is allowed on this node.

getAttributeNames

public java.util.Collection<java.lang.String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Specified by:

getAttributeNames in interface XmlNode

Overrides:

getAttributeNames in class AbstractXmlNode

Returns:

A collection of attribute names that are allowed for the node