org.jvoicexml.xml.ccxml
Class Createcall

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

All Implemented Interfaces:

XmlWritable, Node

public final class Createcall
extends CcxmlNode

A CCXML document can attempt to place an outgoing call with <createcall>. This element will instruct the platform to allocate a Connection and attempt to place an outgoing call to a specified address. The element is non-blocking, and the CCXML document is immediately free to perform other tasks, such as initiating dialog interaction with another caller. The CCXML interpreter will receive an asynchronous event when the call attempt is completed. An <eventprocessor> <transition> block can handle this event and perform further call control, such as conferencing. If the call was successfully placed, the transition block can also initiate a dialog interaction with the called party.

Version:

$Revision: 1.5 $

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

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_AAI An ECMAScript expression which returns a string of application-to-application information to be passed to the destination endpoint when establishing the connection.
static String	ATTRIBUTE_CALLERID An ECMAScript expression which returns a string defining the caller identity to be used when making the outbound connection.
static String	ATTRIBUTE_CONNECTIONID An ECMAScript expression which returns a string defining the caller identity to be used when making the outbound connection.
static String	ATTRIBUTE_DEST An ECMAScript expression which returns a string that is the target of the outbound telephone call.
static String	ATTRIBUTE_HINTS ECMAScript expression that returns an ECMAScript object The ECMAScript object returned contains information which may be used by the implementing platform when establishing the outbound connection.
static String	ATTRIBUTE_JOINDIRECTION An ECMAScript expression that defines the direction of the media flow between the newly created connection, and the existing connection/conference/dialog referenced by joinid.
static String	ATTRIBUTE_JOINID An ECMAScript expression that identifies a connection, conference, or dialog ID that the new call will be joined to.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_TIMEOUT The character string returned is interpreted as a time interval.
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

Createcall()
Construct a new createcall object without a node.

Createcall(Node node)
Construct a new createcall object.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
String	getAai() Retrieve the aai attribute.
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
String	getCallerid() Retrieve the callerid attribute.
String	getConnectionid() Retrieve the connectionid attribute.
String	getDest() Retrieve the dest attribute.
String	getHints() Retrieve the hints attribute.
String	getJoindirection() Retrieve the joindirection attribute.
String	getJoinid() Retrieve the joinid attribute.
String	getTagName() Get the name of the tag for the derived node.
String	getTimeout() Retrieve the timeout attribute.
XmlNode	newInstance(Node n) Create a new instance for the given node.
void	setAai(String aai) Set the aai attribute.
void	setCallerid(String callerid) Set the callerid attribute.
void	setConnectionid(String connectionid) Set the connectionid attribute.
void	setDest(String dest) Set the dest attribute.
void	setHints(String hints) Set the hints attribute.
void	setJoindirection(String joindirection) Set the joindirection attribute.
void	setJoinid(String joinid) Set the joinid attribute.
void	setTimeout(String timeout) Set the timeout 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_AAI

public static final String ATTRIBUTE_AAI

An ECMAScript expression which returns a string of application-to-application information to be passed to the destination endpoint when establishing the connection. Note: Even if an implementation platform accepts the aai data, certain protocols and network elements may prevent the transmission to the target endpoint. If the platform does not support the transmission of aai data it should raise a connection.progressing event and indicate that the use of aai is not supported.

See Also:

Constant Field Values

ATTRIBUTE_CALLERID

public static final String ATTRIBUTE_CALLERID

An ECMAScript expression which returns a string defining the caller identity to be used when making the outbound connection. The format of this information is protocol and platform specific but might consist of a telephone URI, as described in [RFC2806] or a SIP URI as described in [RFC3261]. Note: An implementation platform is not required to use the specified data and certain protocols and network elements may prevent its use. If the platform does not support the specification of callerid it should raise a connection.progressing event and indicate that the use of callerid is not supported.

See Also:

Constant Field Values

ATTRIBUTE_CONNECTIONID

public static final String ATTRIBUTE_CONNECTIONID

An ECMAScript expression which returns a string defining the caller identity to be used when making the outbound connection. The format of this information is protocol and platform specific but might consist of a telephone URI, as described in [RFC2806] or a SIP URI as described in [RFC3261]. Note: An implementation platform is not required to use the specified data and certain protocols and network elements may prevent its use. If the platform does not support the specification of callerid it should raise a connection.progressing event and indicate that the use of callerid is not supported.

See Also:

Constant Field Values

ATTRIBUTE_DEST

public static final String ATTRIBUTE_DEST

An ECMAScript expression which returns a string that is the target of the outbound telephone call. A platform must support a telephone URI, as described in [RFC2806] or a SIP URI as described in [RFC3261].

See Also:

Constant Field Values

ATTRIBUTE_HINTS

public static final String ATTRIBUTE_HINTS

ECMAScript expression that returns an ECMAScript object The ECMAScript object returned contains information which may be used by the implementing platform when establishing the outbound connection. This information may consist of protocol-specific parameters, protocol selection guidelines, or routing hints. Note: The meaning of these hints is specific to the implementing platform.

See Also:

Constant Field Values

ATTRIBUTE_JOINDIRECTION

public static final String ATTRIBUTE_JOINDIRECTION

An ECMAScript expression that defines the direction of the media flow between the newly created connection, and the existing connection/conference/dialog referenced by joinid.

See Also:

Constant Field Values

ATTRIBUTE_JOINID

public static final String ATTRIBUTE_JOINID

An ECMAScript expression that identifies a connection, conference, or dialog ID that the new call will be joined to. This is equivalent, from the perspective of the CCXML application, to performing a <join> immediately following the <createcall> except that no events specific to the join will be generated. However, platforms may use knowledge about the connection/conference/dialog to which the new call will be connected to optimize the call creation process.

See Also:

Constant Field Values

ATTRIBUTE_TIMEOUT

public static final String ATTRIBUTE_TIMEOUT

The character string returned is interpreted as a time interval. This interval begins when createcall is executed. The createcall will fail if not completed by the end of this interval. A completion is defined as the call getting to a CONNECTED state as signaled by a connection.connected event. A failed createcall will return the connection.failed 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

Createcall

public Createcall()

Construct a new createcall object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Createcall

Createcall(Node node)

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

getAai

public String getAai()

Retrieve the aai attribute.

Returns:

Value of the aai attribute.

See Also:

ATTRIBUTE_AAI

setAai

public void setAai(String aai)

Set the aai attribute.

Parameters:

aai - Value of the aai attribute.

See Also:

ATTRIBUTE_AAI

getCallerid

public String getCallerid()

Retrieve the callerid attribute.

Returns:

Value of the callerid attribute.

See Also:

ATTRIBUTE_CALLERID

setCallerid

public void setCallerid(String callerid)

Set the callerid attribute.

Parameters:

callerid - Value of the callerid attribute.

See Also:

ATTRIBUTE_CALLERID

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

getDest

public String getDest()

Retrieve the dest attribute.

Returns:

Value of the dest attribute.

See Also:

ATTRIBUTE_DEST

setDest

public void setDest(String dest)

Set the dest attribute.

Parameters:

dest - Value of the dest attribute.

See Also:

ATTRIBUTE_DEST

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

getJoindirection

public String getJoindirection()

Retrieve the joindirection attribute.

Returns:

Value of the joindirection attribute.

See Also:

ATTRIBUTE_JOINDIRECTION

setJoindirection

public void setJoindirection(String joindirection)

Set the joindirection attribute.

Parameters:

joindirection - Value of the joindirection attribute.

See Also:

ATTRIBUTE_JOINDIRECTION

getJoinid

public String getJoinid()

Retrieve the joinid attribute.

Returns:

Value of the joinid attribute.

See Also:

ATTRIBUTE_JOINID

setJoinid

public void setJoinid(String joinid)

Set the joinid attribute.

Parameters:

joinid - Value of the joinid attribute.

See Also:

ATTRIBUTE_JOINID

getTimeout

public String getTimeout()

Retrieve the timeout attribute.

Returns:

Value of the timeout attribute.

See Also:

ATTRIBUTE_TIMEOUT

setTimeout

public void setTimeout(String timeout)

Set the timeout attribute.

Parameters:

timeout - Value of the timeout attribute.

See Also:

ATTRIBUTE_TIMEOUT

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