org.jvoicexml.xml.ccxml

Class Disconnect

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.ccxml.Disconnect

All Implemented Interfaces:

CcxmlNode, XmlNode, org.w3c.dom.Node

public final class Disconnect
extends AbstractXmlNode

A CCXML document MAY disconnect a call leg on a Connection by using <disconnect> . The underlying platform will send the appropriate protocol messages to perform the disconnect, and send an asynchronous event to the CCXML document when the disconnect operation completes. If the connection had been bridged when the <disconnect> request was made, the platform will tear down all bridges to the connection and send a conference.unjoined to the CCXML document once the media paths have been freed. Note the platform is not required to generate the connection.disconnected or conference.unjoined in any particular order.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_CONNECTIONID An ECMAScript expression which returns a string that is the id of a call leg that should be disconnected.
static java.lang.String	ATTRIBUTE_HINTS The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network disconnecting the connection.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_REASON An ECMAScript expression which returns a string that is the reason the call is being disconnected.
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
Disconnect() Construct a new disconnect 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	getConnectionid() Retrieve the connectionid attribute.
java.lang.String	getHints() Retrieve the hints attribute.
java.lang.String	getReason() Retrieve the reason 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	setConnectionid(java.lang.String connectionid) Set the connectionid attribute.
void	setHints(java.lang.String hints) Set the hints attribute.
void	setReason(java.lang.String reason) Set the reason 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_CONNECTIONID

public static final java.lang.String ATTRIBUTE_CONNECTIONID

An ECMAScript expression which returns a string that is the id of a call leg that should be disconnected. If the connectionid attribute is omitted, the interpreter will disconnect 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 java.lang.String ATTRIBUTE_HINTS

The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network disconnecting the connection. This information may consist of protocol-specific parameters. Note: The meaning of these hints is specific to the implementing platform and protocol.

See Also:

Constant Field Values

ATTRIBUTE_REASON

public static final java.lang.String ATTRIBUTE_REASON

An ECMAScript expression which returns a string that is the reason the call is being disconnected.

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

Disconnect

public Disconnect()

Construct a new disconnect object without a node.

This is necessary for the node factory.

See Also:

CcxmlNodeFactory

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

getConnectionid

public java.lang.String getConnectionid()

Retrieve the connectionid attribute.

Returns:

Value of the connectionid attribute.

See Also:

ATTRIBUTE_CONNECTIONID

setConnectionid

public void setConnectionid(java.lang.String connectionid)

Set the connectionid attribute.

Parameters:

connectionid - Value of the connectionid attribute.

See Also:

ATTRIBUTE_CONNECTIONID

getHints

public java.lang.String getHints()

Retrieve the hints attribute.

Returns:

Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

setHints

public void setHints(java.lang.String hints)

Set the hints attribute.

Parameters:

hints - Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

getReason

public java.lang.String getReason()

Retrieve the reason attribute.

Returns:

Value of the reason attribute.

See Also:

ATTRIBUTE_REASON

setReason

public void setReason(java.lang.String reason)

Set the reason attribute.

Parameters:

reason - Value of the reason attribute.

See Also:

ATTRIBUTE_REASON

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