org.jvoicexml.xml.vxml

Class Subdialog

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Subdialog

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Subdialog
extends AbstractXmlNode

Invoke another dialog as a subdialog of the current one.

See Also:

Return

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_COND An expression that must evaluate to true after conversion to boolean in order for the form item to be visited.
static java.lang.String	ATTRIBUTE_ENCTYPE The media encoding type of the submitted document (when the value of method is "post").
static java.lang.String	ATTRIBUTE_EXPR The initial value of the form item variable; default is ECMAScript undefined.
static java.lang.String	ATTRIBUTE_FETCHAUDIO The URI of the audio clip to play while the fetch is being done.
static java.lang.String	ATTRIBUTE_FETCHHINT Defines when the interpreter context should retrieve content from the server. prefetch indicates a file may be downloaded when the page is loaded, whereas safe indicates a file that should only be downloaded when actually needed.
static java.lang.String	ATTRIBUTE_FETCHTIMEOUT The interval to wait for the content to be returned before throwing an error.badfetch event.
static java.lang.String	ATTRIBUTE_MAXAGE Indicates that the document is willing to use content whose age is no greater than the specified time in seconds.
static java.lang.String	ATTRIBUTE_MAXSTALE Indicates that the document is willing to use content that has exceeded its expiration time.
static java.lang.String	ATTRIBUTE_METHOD The request method: get (the default) or post.
static java.lang.String	ATTRIBUTE_NAME The result returned from the subdialog, an ECMAScript object whose properties are the ones defined in the namelist attribute of the <return> element.
static java.lang.String	ATTRIBUTE_NAMELIST The list of variables to submit.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_SRC The URI of the subdialog.
static java.lang.String	ATTRIBUTE_SRCEXPR An ECMAScript expression yielding the URI of the subdialog.
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
Subdialog() Construct a new subdialog object without a node.

Method Summary

Modifier and Type	Method and Description
Text	addText(java.lang.String text) Create a new text within this node.
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	getCond() Retrieve the cond attribute.
java.lang.String	getEnctype() Retrieve the enctype attribute.
java.lang.String	getExpr() Retrieve the expr attribute.
java.lang.String	getFetchaudio() Retrieve the fetchaudio attribute.
java.lang.String	getFetchhint() Retrieve the fetchhint attribute.
java.lang.String	getFetchtimeout() Retrieve the fetchtimeout attribute.
java.lang.String	getMaxage() Retrieve the maxage attribute.
java.lang.String	getMaxstale() Retrieve the maxstale attribute.
java.lang.String	getMethod() Retrieve the method attribute.
java.lang.String	getName() Retrieve the name attribute.
java.lang.String	getNamelist() Retrieve the namelist attribute.
java.lang.String	getSrc() Retrieve the src attribute.
java.lang.String	getSrcexpr() Retrieve the srcexpr attribute.
java.net.URI	getSrcUri() Retrieve the src attribute.
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	setCond(java.lang.String cond) Set the cond attribute.
void	setEnctype(java.lang.String enctype) Set the enctype attribute.
void	setExpr(java.lang.String expr) Set the expr attribute.
void	setFetchaudio(java.lang.String fetchaudio) Set the fetchaudio attribute.
void	setFetchhint(java.lang.String fetchhint) Set the fetchhint attribute.
void	setFetchtimeout(java.lang.String fetchtimeout) Set the fetchtimeout attribute.
void	setMaxage(java.lang.String maxage) Set the maxage attribute.
void	setMaxstale(java.lang.String maxstale) Set the maxstale attribute.
void	setMethod(java.lang.String method) Set the method attribute.
void	setName(java.lang.String name) Set the name attribute.
void	setNamelist(java.lang.String namelist) Set the namelist attribute.
void	setSrc(java.lang.String src) Set the src attribute.
void	setSrc(java.net.URI uri) Set the src attribute.
void	setSrcexpr(java.lang.String srcexpr) Set the srcexpr 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_NAME

public static final java.lang.String ATTRIBUTE_NAME

The result returned from the subdialog, an ECMAScript object whose properties are the ones defined in the namelist attribute of the <return> element.

See Also:

Constant Field Values

ATTRIBUTE_EXPR

public static final java.lang.String ATTRIBUTE_EXPR

The initial value of the form item variable; default is ECMAScript undefined. If initialized to a value, then the form item will not be visited unless the form item variable is cleared.

See Also:

Constant Field Values

ATTRIBUTE_COND

public static final java.lang.String ATTRIBUTE_COND

An expression that must evaluate to true after conversion to boolean in order for the form item to be visited.

See Also:

Constant Field Values

ATTRIBUTE_NAMELIST

public static final java.lang.String ATTRIBUTE_NAMELIST

The list of variables to submit. The default is to submit no variables. If a namelist is supplied, it may contain individual variable references which are submitted with the same qualification used in the namelist. Declared VoiceXML and ECMAScript variables can be referenced. If an undeclared variable is referenced in the namelist, then an error.semantic is thrown.

See Also:

Constant Field Values

ATTRIBUTE_SRC

public static final java.lang.String ATTRIBUTE_SRC

The URI of the subdialog.

See Also:

Constant Field Values

ATTRIBUTE_SRCEXPR

public static final java.lang.String ATTRIBUTE_SRCEXPR

An ECMAScript expression yielding the URI of the subdialog.

See Also:

Constant Field Values

ATTRIBUTE_METHOD

public static final java.lang.String ATTRIBUTE_METHOD

The request method: get (the default) or post.

See Also:

Constant Field Values

ATTRIBUTE_ENCTYPE

public static final java.lang.String ATTRIBUTE_ENCTYPE

The media encoding type of the submitted document (when the value of method is "post"). The default is application/x-www-form-urlencoded. Interpreters must also support multipart/form-data and may support additional encoding types.

See Also:

Constant Field Values

ATTRIBUTE_FETCHAUDIO

public static final java.lang.String ATTRIBUTE_FETCHAUDIO

The URI of the audio clip to play while the fetch is being done. If not specified, the fetchaudio property is used, and if that property is not set, no audio is played during the fetch. The fetching of the audio clip is governed by the audiofetchhint, audiomaxage, audiomaxstale, and fetchtimeout properties in effect at the time of the fetch. The playing of the audio clip is governed by the fetchaudiodelay, and fetchaudiominimum properties in effect at the time of the fetch.

See Also:

Constant Field Values

ATTRIBUTE_FETCHTIMEOUT

public static final java.lang.String ATTRIBUTE_FETCHTIMEOUT

The interval to wait for the content to be returned before throwing an error.badfetch event. This defaults to the fetchtimeout property.

See Also:

Constant Field Values

ATTRIBUTE_FETCHHINT

public static final java.lang.String ATTRIBUTE_FETCHHINT

Defines when the interpreter context should retrieve content from the server. prefetch indicates a file may be downloaded when the page is loaded, whereas safe indicates a file that should only be downloaded when actually needed. This defaults to the audiofetchhint property.

See Also:

Constant Field Values

ATTRIBUTE_MAXAGE

public static final java.lang.String ATTRIBUTE_MAXAGE

Indicates that the document is willing to use content whose age is no greater than the specified time in seconds. The document is not willing to use stale content, unless maxstale is also provided. This defaults to the audiomaxage property.

See Also:

Constant Field Values

ATTRIBUTE_MAXSTALE

public static final java.lang.String ATTRIBUTE_MAXSTALE

Indicates that the document is willing to use content that has exceeded its expiration time. If maxstale is assigned a value, then the document is willing to accept content that has exceeded its expiration time by no more than the specified number of seconds. This defaults to the audiomaxstale property.

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

Subdialog

public Subdialog()

Construct a new subdialog 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

getName

public java.lang.String getName()

Retrieve the name attribute.

Returns:

Value of the name attribute.

See Also:

ATTRIBUTE_NAME

setName

public void setName(java.lang.String name)

Set the name attribute.

Parameters:

name - Value of the name attribute.

See Also:

ATTRIBUTE_NAME

getExpr

public java.lang.String getExpr()

Retrieve the expr attribute.

Returns:

Value of the expr attribute.

See Also:

ATTRIBUTE_EXPR

setExpr

public void setExpr(java.lang.String expr)

Set the expr attribute.

Parameters:

expr - Value of the expr attribute.

See Also:

ATTRIBUTE_EXPR

getCond

public java.lang.String getCond()

Retrieve the cond attribute.

Returns:

Value of the cond attribute.

See Also:

ATTRIBUTE_COND

setCond

public void setCond(java.lang.String cond)

Set the cond attribute.

Parameters:

cond - Value of the cond attribute.

See Also:

ATTRIBUTE_COND

getNamelist

public java.lang.String getNamelist()

Retrieve the namelist attribute.

Returns:

Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

setNamelist

public void setNamelist(java.lang.String namelist)

Set the namelist attribute.

Parameters:

namelist - Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

getSrc

public java.lang.String getSrc()

Retrieve the src attribute.

Returns:

Value of the src attribute.

See Also:

ATTRIBUTE_SRC

getSrcUri

public java.net.URI getSrcUri()
                       throws java.net.URISyntaxException

Retrieve the src attribute.

Returns:

Value of the src attribute.

Throws:

java.net.URISyntaxException - Src attribute does not denote a valid URI.

Since:

0.7.4

See Also:

ATTRIBUTE_SRC

setSrc

public void setSrc(java.lang.String src)

Set the src attribute.

Parameters:

src - Value of the src attribute.

See Also:

ATTRIBUTE_SRC

setSrc

public void setSrc(java.net.URI uri)

Set the src attribute.

Parameters:

uri - Value of the src attribute.

Since:

0.7.4

See Also:

ATTRIBUTE_SRC

getSrcexpr

public java.lang.String getSrcexpr()

Retrieve the srcexpr attribute.

Returns:

Value of the srcexpr attribute.

See Also:

ATTRIBUTE_SRCEXPR

setSrcexpr

public void setSrcexpr(java.lang.String srcexpr)

Set the srcexpr attribute.

Parameters:

srcexpr - Value of the srcexpr attribute.

See Also:

ATTRIBUTE_SRCEXPR

getMethod

public java.lang.String getMethod()

Retrieve the method attribute.

Returns:

Value of the method attribute.

See Also:

ATTRIBUTE_METHOD

setMethod

public void setMethod(java.lang.String method)

Set the method attribute.

Parameters:

method - Value of the method attribute.

See Also:

ATTRIBUTE_METHOD

getEnctype

public java.lang.String getEnctype()

Retrieve the enctype attribute.

Returns:

Value of the enctype attribute.

See Also:

ATTRIBUTE_ENCTYPE

setEnctype

public void setEnctype(java.lang.String enctype)

Set the enctype attribute.

Parameters:

enctype - Value of the enctype attribute.

See Also:

ATTRIBUTE_ENCTYPE

getFetchaudio

public java.lang.String getFetchaudio()

Retrieve the fetchaudio attribute.

Returns:

Value of the fetchaudio attribute.

See Also:

ATTRIBUTE_FETCHAUDIO

setFetchaudio

public void setFetchaudio(java.lang.String fetchaudio)

Set the fetchaudio attribute.

Parameters:

fetchaudio - Value of the fetchaudio attribute.

See Also:

ATTRIBUTE_FETCHAUDIO

getFetchhint

public java.lang.String getFetchhint()

Retrieve the fetchhint attribute.

Returns:

Value of the fetchhint attribute.

See Also:

ATTRIBUTE_FETCHHINT

setFetchhint

public void setFetchhint(java.lang.String fetchhint)

Set the fetchhint attribute.

Parameters:

fetchhint - Value of the fetchhint attribute.

See Also:

ATTRIBUTE_FETCHHINT

getFetchtimeout

public java.lang.String getFetchtimeout()

Retrieve the fetchtimeout attribute.

Returns:

Value of the fetchtimeout attribute.

See Also:

ATTRIBUTE_FETCHTIMEOUT

setFetchtimeout

public void setFetchtimeout(java.lang.String fetchtimeout)

Set the fetchtimeout attribute.

Parameters:

fetchtimeout - Value of the fetchtimeout attribute.

See Also:

ATTRIBUTE_FETCHTIMEOUT

getMaxage

public java.lang.String getMaxage()

Retrieve the maxage attribute.

Returns:

Value of the maxage attribute.

See Also:

ATTRIBUTE_MAXAGE

setMaxage

public void setMaxage(java.lang.String maxage)

Set the maxage attribute.

Parameters:

maxage - Value of the maxage attribute.

See Also:

ATTRIBUTE_MAXAGE

getMaxstale

public java.lang.String getMaxstale()

Retrieve the maxstale attribute.

Returns:

Value of the maxstale attribute.

See Also:

ATTRIBUTE_MAXSTALE

setMaxstale

public void setMaxstale(java.lang.String maxstale)

Set the maxstale attribute.

Parameters:

maxstale - Value of the maxstale attribute.

See Also:

ATTRIBUTE_MAXSTALE

addText

public Text addText(java.lang.String text)

Create a new text within this node.

Parameters:

text - The text to be added.

Returns:

The new created text.

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