org.jvoicexml.xml.ccxml
Class Createconference

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

All Implemented Interfaces:

XmlWritable, Node

public final class Createconference
extends CcxmlNode

A CCXML document can attempt to create or attach to a Conference Object using <createconference>. This element will instruct the implementation to allocate a Conference Object using the specified options. The successful execution of <createconference> will result in the generation of a conference.created event. If for any reason the implementation is unable to create the Conference Object using the specified options it MUST fail with a error.conference.create event.

Version:

$Revision: 1.4 $

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

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_CONFERENCEID An ECMAScript left hand side expression evaluating to a previously defined variable.
static String	ATTRIBUTE_CONFNAME An ECMAScript left hand side expression evaluating to a previously defined variable.
static String	ATTRIBUTE_HINTS The ECMAScript object returned contains information which may be used by the implementing platform when creating the conference.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_RESERVEDLISTENERS An ECMAScript expression which returns the number of guaranteed listener slots the conference mixer should reserve.
static String	ATTRIBUTE_RESERVEDTALKERS An ECMAScript expression which returns the number of guaranteed speaker slots the conference mixer should reserve.
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

Createconference()
Construct a new createconference object without a node.

Createconference(Node node)
Construct a new createconference 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	getConfname() Retrieve the confname attribute.
String	getHints() Retrieve the hints attribute.
String	getReservedlisteners() Retrieve the reservedlisteners attribute.
String	getReservedtalkers() Retrieve the reservedtalkers 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	setConferenceid(String conferenceid) Set the conferenceid attribute.
void	setConfname(String confname) Set the confname attribute.
void	setHints(String hints) Set the hints attribute.
void	setReservedlisteners(String reservedlisteners) Set the reservedlisteners attribute.
void	setReservedtalkers(String reservedtalkers) Set the reservedtalkers 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 ECMAScript left hand side expression evaluating to a previously defined variable. The value of the attribute will receive the conference identifier. A conference identifier should be globally unique, so that conferences can be uniquely addressed and possibly connected to. It should be in URI format.

See Also:

Constant Field Values

ATTRIBUTE_CONFNAME

public static final String ATTRIBUTE_CONFNAME

An ECMAScript left hand side expression evaluating to a previously defined variable. The value of the attribute will receive the conference identifier. A conference identifier should be globally unique, so that conferences can be uniquely addressed and possibly connected to. It should be in URI format.

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 when creating the conference. Note: The meaning of these hints is specific to the implementing platform and the event processor.

See Also:

Constant Field Values

ATTRIBUTE_RESERVEDLISTENERS

public static final String ATTRIBUTE_RESERVEDLISTENERS

An ECMAScript expression which returns the number of guaranteed listener slots the conference mixer should reserve. If the conference already exists, then this attribute will be ignored. If the conference mixer is unable to reserve this many listener slots, the createconference must fail with a error.conference.create event.

See Also:

Constant Field Values

ATTRIBUTE_RESERVEDTALKERS

public static final String ATTRIBUTE_RESERVEDTALKERS

An ECMAScript expression which returns the number of guaranteed speaker slots the conference mixer should reserve. If the conference already exists, then this attribute will be ignored. If the conference mixer is unable to reserve this many speaker slots, the createconference must fail with a error.conference.create event.

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

Createconference

public Createconference()

Construct a new createconference object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Createconference

Createconference(Node node)

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

getConfname

public String getConfname()

Retrieve the confname attribute.

Returns:

Value of the confname attribute.

See Also:

ATTRIBUTE_CONFNAME

setConfname

public void setConfname(String confname)

Set the confname attribute.

Parameters:

confname - Value of the confname attribute.

See Also:

ATTRIBUTE_CONFNAME

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

getReservedlisteners

public String getReservedlisteners()

Retrieve the reservedlisteners attribute.

Returns:

Value of the reservedlisteners attribute.

See Also:

ATTRIBUTE_RESERVEDLISTENERS

setReservedlisteners

public void setReservedlisteners(String reservedlisteners)

Set the reservedlisteners attribute.

Parameters:

reservedlisteners - Value of the reservedlisteners attribute.

See Also:

ATTRIBUTE_RESERVEDLISTENERS

getReservedtalkers

public String getReservedtalkers()

Retrieve the reservedtalkers attribute.

Returns:

Value of the reservedtalkers attribute.

See Also:

ATTRIBUTE_RESERVEDTALKERS

setReservedtalkers

public void setReservedtalkers(String reservedtalkers)

Set the reservedtalkers attribute.

Parameters:

reservedtalkers - Value of the reservedtalkers attribute.

See Also:

ATTRIBUTE_RESERVEDTALKERS

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