org.jvoicexml.xml.ccxml
Class Accept

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

All Implemented Interfaces:

XmlWritable, Node

public final class Accept
extends CcxmlNode

When a CCXML document receives a connection.alerting event within an eventprocessor, the execution of an accept within the transition block will cause the underlying platform to signal the telephony system to connect the call. The CCXML document MAY then initiate interactive dialog sessions with the incoming caller, or perform other telephony operations (e.g., place outgoing calls, join calls, etc).

Version:

$Revision: 1.4 $

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

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_CONNECTIONID An ECMAScript expression which returns a string that is the identifier of a Connection on which the incoming call is signaled.
static String	ATTRIBUTE_HINTS An ECMAScript expression which returns a string that is the identifier of a Connection on which the incoming call is signaled.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
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

Accept()
Construct a new accept object without a node.

Accept(Node node)
Construct a new accept 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	getConnectionid() Retrieve the connectionid attribute.
String	getHints() Retrieve the hints attribute.
String	getTagName() Get the name of the tag for the derived node.
XmlNode	newInstance(Node n) Create a new instance for the given node.
void	setConnectionid(String connectionid) Set the connectionid attribute.
void	setHints(String hints) Set the hints 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_CONNECTIONID

public static final String ATTRIBUTE_CONNECTIONID

An ECMAScript expression which returns a string that is the identifier of a Connection on which the incoming call is signaled. If the connectionid attribute is omitted, the interpreter will accept using the id indicated in the current event being processed. If the attribute value is invalid or there is no valid default value, an error.semantic event will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_HINTS

public static final String ATTRIBUTE_HINTS

An ECMAScript expression which returns a string that is the identifier of a Connection on which the incoming call is signaled. If the connectionid attribute is omitted, the interpreter will accept using the id indicated in the current event being processed. If the attribute value is invalid or there is no valid default value, an error.semantic event will be thrown.

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

Accept

public Accept()

Construct a new accept object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Accept

Accept(Node node)

Construct a new accept 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.

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

getHints

public String getHints()

Retrieve the hints attribute.

Returns:

Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

setHints

public void setHints(String hints)

Set the hints attribute.

Parameters:

hints - Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

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