org.jvoicexml.xml.ccxml
Class Dialogprepare

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.ccxml.CcxmlNode
          org.jvoicexml.xml.ccxml.Dialogprepare

All Implemented Interfaces:

XmlWritable, Node

public final class Dialogprepare
extends CcxmlNode

<dialogprepare> is used to get an appropriate dialog handler ready to process, it is used as the precursor to a <dialogstart> request. The element includes a URI reference to the initial document for the dialog. The new dialog is prepared on a separate logical execution thread (this MAY be a thread, process, or system depending upon platform implementation) and does not block the processing of further events by the CCXML session. The use of the <dialogprepare> element is entirely optional, applications may choose to simply use <dialogstart> without prior preparation.

Version:

$Revision: 1.4 $

Copyright © 2005 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_CONFERENCEID An Optional ECMAScript expression which returns the identifier of`a confe2ence bridge.
static String	ATTRIBUTE_CONNECTIONID An Optional ECMAScript expression which returns the identifier of a connection.
static String	ATTRIBUTE_DIALOGID An ECMAScript left hand side expression evaluating to a previously defined variable.
static String	ATTRIBUTE_ENCTYPE An ECMAScript expression which returns a character string that indicates the HTTP method to use.
static String	ATTRIBUTE_MAXAGE The character string returned is interpreted as a time interval.
static String	ATTRIBUTE_MAXSTALE The character string returned is interpreted as a time interval.
static String	ATTRIBUTE_MEDIADIRECTION An ECMAScript expression that defines the direction of the media flow between the Dialog and the Connection or Conference specified by the connectionid or conferenceid attribute.
static String	ATTRIBUTE_METHOD An ECMAScript expression which returns a character string that indicates the HTTP method to use.
static String	ATTRIBUTE_NAMELIST A list of one or more whitespace separated CCXML variable names.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_SRC An ECMAScript expression which returns a character string identifying the URI of the dialog document that the dialog interpreter should prepare.
static String	ATTRIBUTE_TYPE An ECMAScript expression which returns a character string that specifies the MIME type of the document, and as a result determines which dialog manager environment is actually used.
private static Set<String>	CHILD_TAGS Valid child tags for this node.
static String	TAG_NAME Name of the tag.

Fields inherited from class org.jvoicexml.xml.XmlNode

node

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

Dialogprepare()
Construct a new dialogprepare object without a node.

Dialogprepare(Node node)
Construct a new dialogprepare object.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
String	getConferenceid() Retrieve the conferenceid attribute.
String	getConnectionid() Retrieve the connectionid attribute.
String	getDialogid() Retrieve the dialogid attribute.
String	getEnctype() Retrieve the enctype attribute.
String	getMaxage() Retrieve the maxage attribute.
String	getMaxstale() Retrieve the maxstale attribute.
String	getMediadirection() Retrieve the mediadirection attribute.
String	getMethod() Retrieve the method attribute.
String	getNamelist() Retrieve the namelist attribute.
String	getSrc() Retrieve the src attribute.
String	getTagName() Get the name of the tag for the derived node.
String	getType() Retrieve the type attribute.
XmlNode	newInstance(Node n) Create a new instance for the given node.
void	setConferenceid(String conferenceid) Set the conferenceid attribute.
void	setConnectionid(String connectionid) Set the connectionid attribute.
void	setDialogid(String dialogid) Set the dialogid attribute.
void	setEnctype(String enctype) Set the enctype attribute.
void	setMaxage(String maxage) Set the maxage attribute.
void	setMaxstale(String maxstale) Set the maxstale attribute.
void	setMediadirection(String mediadirection) Set the mediadirection attribute.
void	setMethod(String method) Set the method attribute.
void	setNamelist(String namelist) Set the namelist attribute.
void	setSrc(String src) Set the src attribute.
void	setType(String type) Set the type attribute.

Methods inherited from class org.jvoicexml.xml.ccxml.CcxmlNode

getChildNodes, getFirstChild, getLastChild, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.jvoicexml.xml.XmlNode

addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributes, getBaseURI, getChildNodes, getFeature, getLocalName, getNamespaceURI, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString, writeChildrenXml, writeXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG_NAME

public static final String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_CONFERENCEID

public static final String ATTRIBUTE_CONFERENCEID

An Optional ECMAScript expression which returns the identifier of`a confe2ence bridge. A connection will be allocated for the dialog being prepared. If the attribute value is invalid, an error.semantic event will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_CONNECTIONID

public static final String ATTRIBUTE_CONNECTIONID

An Optional ECMAScript expression which returns the identifier of a connection. The specified connection will be associated with the dialog being prepared. If the attribute value is invalid, an error.semantic event will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_DIALOGID

public static final String ATTRIBUTE_DIALOGID

An ECMAScript left hand side expression evaluating to a previously defined variable. The value of the attribute will receive a dialog identifier value for the launched dialog interpreter instance. This identifier may be used on future invocations of dialogstart, dialogterminate, join, or unjoin.

See Also:

Constant Field Values

ATTRIBUTE_ENCTYPE

public static final String ATTRIBUTE_ENCTYPE

An ECMAScript expression which returns a character string that indicates the HTTP method to use.

See Also:

Constant Field Values

ATTRIBUTE_MAXAGE

public static final String ATTRIBUTE_MAXAGE

The character string returned is interpreted as a time interval. This indicates that the document is willing to use content whose age is no greater than the specified time in seconds (cf. 'max-age' in HTTP 1.1 [RFC2616]). The document is not willing to use stale content, unless maxstale is also provided.

See Also:

Constant Field Values

ATTRIBUTE_MAXSTALE

public static final String ATTRIBUTE_MAXSTALE

The character string returned is interpreted as a time interval. This indicates that the document is willing to use content that has exceeded its expiration time (cf. 'max-age' in HTTP 1.1 [RFC2616]). 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.

See Also:

Constant Field Values

ATTRIBUTE_MEDIADIRECTION

public static final String ATTRIBUTE_MEDIADIRECTION

An ECMAScript expression that defines the direction of the media flow between the Dialog and the Connection or Conference specified by the connectionid or conferenceid attribute.

See Also:

Constant Field Values

ATTRIBUTE_METHOD

public static final String ATTRIBUTE_METHOD

An ECMAScript expression which returns a character string that indicates the HTTP method to use.

See Also:

Constant Field Values

ATTRIBUTE_NAMELIST

public static final String ATTRIBUTE_NAMELIST

A list of one or more whitespace separated CCXML variable names. These variables will be submitted to the server, with the same qualification as used in the namelist. When an ECMAscript variable is submitted to the server, its value is first converted into a string before being submitted. If the variable is an ECMAScript Object, the mechanism by which it is submitted is not currently defined. Instead of submitting ECMAScript Objects directly, the application developer may explicitly submit the properties of an Object. e.g. "date.month date.year".

See Also:

Constant Field Values

ATTRIBUTE_SRC

public static final String ATTRIBUTE_SRC

An ECMAScript expression which returns a character string identifying the URI of the dialog document that the dialog interpreter should prepare.

See Also:

Constant Field Values

ATTRIBUTE_TYPE

public static final String ATTRIBUTE_TYPE

An ECMAScript expression which returns a character string that specifies the MIME type of the document, and as a result determines which dialog manager environment is actually used.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

CHILD_TAGS

private static final Set<String> CHILD_TAGS

Valid child tags for this node.

Constructor Detail

Dialogprepare

public Dialogprepare()

Construct a new dialogprepare object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Dialogprepare

Dialogprepare(Node node)

Construct a new dialogprepare object.

Parameters:

node - The encapsulated node.

Method Detail

getTagName

public String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in class XmlNode

Returns:

name of the tag.

newInstance

public XmlNode newInstance(Node n)

Create a new instance for the given node.

Specified by:

newInstance in class XmlNode

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

getConferenceid

public String getConferenceid()

Retrieve the conferenceid attribute.

Returns:

Value of the conferenceid attribute.

See Also:

ATTRIBUTE_CONFERENCEID

setConferenceid

public void setConferenceid(String conferenceid)

Set the conferenceid attribute.

Parameters:

conferenceid - Value of the conferenceid attribute.

See Also:

ATTRIBUTE_CONFERENCEID

getConnectionid

public String getConnectionid()

Retrieve the connectionid attribute.

Returns:

Value of the connectionid attribute.

See Also:

ATTRIBUTE_CONNECTIONID

setConnectionid

public void setConnectionid(String connectionid)

Set the connectionid attribute.

Parameters:

connectionid - Value of the connectionid attribute.

See Also:

ATTRIBUTE_CONNECTIONID

getDialogid

public String getDialogid()

Retrieve the dialogid attribute.

Returns:

Value of the dialogid attribute.

See Also:

ATTRIBUTE_DIALOGID

setDialogid

public void setDialogid(String dialogid)

Set the dialogid attribute.

Parameters:

dialogid - Value of the dialogid attribute.

See Also:

ATTRIBUTE_DIALOGID

getEnctype

public String getEnctype()

Retrieve the enctype attribute.

Returns:

Value of the enctype attribute.

See Also:

ATTRIBUTE_ENCTYPE

setEnctype

public void setEnctype(String enctype)

Set the enctype attribute.

Parameters:

enctype - Value of the enctype attribute.

See Also:

ATTRIBUTE_ENCTYPE

getMaxage

public String getMaxage()

Retrieve the maxage attribute.

Returns:

Value of the maxage attribute.

See Also:

ATTRIBUTE_MAXAGE

setMaxage

public void setMaxage(String maxage)

Set the maxage attribute.

Parameters:

maxage - Value of the maxage attribute.

See Also:

ATTRIBUTE_MAXAGE

getMaxstale

public String getMaxstale()

Retrieve the maxstale attribute.

Returns:

Value of the maxstale attribute.

See Also:

ATTRIBUTE_MAXSTALE

setMaxstale

public void setMaxstale(String maxstale)

Set the maxstale attribute.

Parameters:

maxstale - Value of the maxstale attribute.

See Also:

ATTRIBUTE_MAXSTALE

getMediadirection

public String getMediadirection()

Retrieve the mediadirection attribute.

Returns:

Value of the mediadirection attribute.

See Also:

ATTRIBUTE_MEDIADIRECTION

setMediadirection

public void setMediadirection(String mediadirection)

Set the mediadirection attribute.

Parameters:

mediadirection - Value of the mediadirection attribute.

See Also:

ATTRIBUTE_MEDIADIRECTION

getMethod

public String getMethod()

Retrieve the method attribute.

Returns:

Value of the method attribute.

See Also:

ATTRIBUTE_METHOD

setMethod

public void setMethod(String method)

Set the method attribute.

Parameters:

method - Value of the method attribute.

See Also:

ATTRIBUTE_METHOD

getNamelist

public String getNamelist()

Retrieve the namelist attribute.

Returns:

Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

setNamelist

public void setNamelist(String namelist)

Set the namelist attribute.

Parameters:

namelist - Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

getSrc

public String getSrc()

Retrieve the src attribute.

Returns:

Value of the src attribute.

See Also:

ATTRIBUTE_SRC

setSrc

public void setSrc(String src)

Set the src attribute.

Parameters:

src - Value of the src attribute.

See Also:

ATTRIBUTE_SRC

getType

public String getType()

Retrieve the type attribute.

Returns:

Value of the type attribute.

See Also:

ATTRIBUTE_TYPE

setType

public void setType(String type)

Set the type attribute.

Parameters:

type - Value of the type attribute.

See Also:

ATTRIBUTE_TYPE

canContainChild

protected boolean canContainChild(String tagName)

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

Specified by:

canContainChild in class XmlNode

Parameters:

tagName - Name of child.

Returns:

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

getAttributeNames

public Collection<String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Overrides:

getAttributeNames in class XmlNode

Returns:

A collection of attribute names that are allowed for the node