org.jvoicexml.xml.ccxml
Class Unjoin

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

All Implemented Interfaces:

XmlWritable, Node

public final class Unjoin
extends CcxmlNode

A CCXML document can attempt to tear down a bridge between two existing connections, conferences, or dialogs using <unjoin>. This element will instruct the implementation to tear down the bridge between two connections/conferences/dialogs specified using the id1 and id2 attributes. The successful execution of<unjoin> will result in the generation of a conference.unjoined event. If for any reason the implementation is unable to terminate the bridge between the specified connections/conferences/dialogs, or if no such bridge exists, it MUST fail with a error.conference.unjoin event. Unjoining two objects that are owned by separate CCXML sessions will result in the generation of a conference.unjoined to each of the sessions. However if the implementation is unable to join the objects an error.conference.unjoin will only be sent to the session issued the <unjoin>.

Version:

$Revision: 1.4 $

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

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_HINTS The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when the two specified Connections, Dialogs or Conferences (id1 and id2) are unjoined.
static String	ATTRIBUTE_ID1 An ECMAScript expression which returns a string that is the identifier of a Connection, Dialog or Conference.
static String	ATTRIBUTE_ID2 An ECMAScript expression which returns a string that is the identifier of a Connection, Dialog or Conference.
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

Unjoin()
Construct a new unjoin object without a node.

Unjoin(Node node)
Construct a new unjoin 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	getHints() Retrieve the hints attribute.
String	getId1() Retrieve the id1 attribute.
String	getId2() Retrieve the id2 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	setHints(String hints) Set the hints attribute.
void	setId1(String id1) Set the id1 attribute.
void	setId2(String id2) Set the id2 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_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 when the two specified Connections, Dialogs or Conferences (id1 and id2) are unjoined. This information may consist of protocol-specific parameters. Note: The meaning of these hints is specific to the implementing platform and the underlying protocol.

See Also:

Constant Field Values

ATTRIBUTE_ID1

public static final String ATTRIBUTE_ID1

An ECMAScript expression which returns a string that is the identifier of a Connection, Dialog or Conference. If the attribute value is invalid an error.semantic event will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_ID2

public static final String ATTRIBUTE_ID2

An ECMAScript expression which returns a string that is the identifier of a Connection, Dialog or Conference. All media streams between the two specified Connections, Dialogs or Conferences (id1 and id2 ) will be torn down. If the attribute value is invalid 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

Unjoin

public Unjoin()

Construct a new unjoin object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Unjoin

Unjoin(Node node)

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

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

getId1

public String getId1()

Retrieve the id1 attribute.

Returns:

Value of the id1 attribute.

See Also:

ATTRIBUTE_ID1

setId1

public void setId1(String id1)

Set the id1 attribute.

Parameters:

id1 - Value of the id1 attribute.

See Also:

ATTRIBUTE_ID1

getId2

public String getId2()

Retrieve the id2 attribute.

Returns:

Value of the id2 attribute.

See Also:

ATTRIBUTE_ID2

setId2

public void setId2(String id2)

Set the id2 attribute.

Parameters:

id2 - Value of the id2 attribute.

See Also:

ATTRIBUTE_ID2

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