org.jvoicexml.xml.ccxml
Class Disconnect

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

All Implemented Interfaces:

XmlWritable, Node

public final class Disconnect
extends CcxmlNode

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.

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 id of a call leg that should be disconnected.
static 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 ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_REASON An ECMAScript expression which returns a string that is the reason the call is being disconnected.
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

Disconnect()
Construct a new disconnect object without a node.

Disconnect(Node node)
Construct a new disconnect 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	getReason() Retrieve the reason 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.
void	setReason(String reason) Set the reason 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 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 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 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 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

Disconnect

public Disconnect()

Construct a new disconnect object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Disconnect

Disconnect(Node node)

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

getReason

public String getReason()

Retrieve the reason attribute.

Returns:

Value of the reason attribute.

See Also:

ATTRIBUTE_REASON

setReason

public void setReason(String reason)

Set the reason attribute.

Parameters:

reason - Value of the reason attribute.

See Also:

ATTRIBUTE_REASON

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