org.jvoicexml.xml.ccxml

Class Send

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.ccxml.Send

All Implemented Interfaces:

CcxmlNode, XmlNode, org.w3c.dom.Node

public final class Send
extends AbstractXmlNode

<send> is used to send messages containing events or other information directly to another CCXML Interpreter other external systems using an Event I/O Processor. The event target of <send/> is specified using the target and targettype attributes. These attributes control how the platform should dispatch the event to its final destination.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_DATA An ECMAScript expression which returns a character string that indicates the type of event being generated.
static java.lang.String	ATTRIBUTE_DELAY The character string returned is interpreted as a time interval.
static java.lang.String	ATTRIBUTE_HINTS The ECMAScript object returned contains information which may be used by the implementing platform to configure the event processor.
static java.lang.String	ATTRIBUTE_NAMELIST A list of zero or more whitespace separated CCXML variable names to be included with the event.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_SENDID An ECMAScript left hand side expression evaluating to a previously defined variable.
static java.lang.String	ATTRIBUTE_TARGET An ECMAScript expression returning the target location of the event.
static java.lang.String	ATTRIBUTE_TARGETTYPE An ECMAScript expression which returns a character string that specifies the type of the Event I/O Processor that the event should be dispatched to.
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
Send() Construct a new send 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	getData() Retrieve the data attribute.
java.lang.String	getDelay() Retrieve the delay attribute.
java.lang.String	getHints() Retrieve the hints attribute.
java.lang.String	getNamelist() Retrieve the namelist attribute.
java.lang.String	getSendid() Retrieve the sendid attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getTarget() Retrieve the target attribute.
java.lang.String	getTargettype() Retrieve the targettype attribute.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setData(java.lang.String data) Set the data attribute.
void	setDelay(java.lang.String delay) Set the delay attribute.
void	setHints(java.lang.String hints) Set the hints attribute.
void	setNamelist(java.lang.String namelist) Set the namelist attribute.
void	setSendid(java.lang.String sendid) Set the sendid attribute.
void	setTarget(java.lang.String target) Set the target attribute.
void	setTargettype(java.lang.String targettype) Set the targettype 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_DATA

public static final java.lang.String ATTRIBUTE_DATA

An ECMAScript expression which returns a character string that indicates the type of event being generated. The event type may include alphanumeric characters and the "." (dot) character. The first character may not be a dot or a digit. Event type names are case-insensitive. If neither the data attribute or inline content is specified, an error.fetch event will be thrown. If used in conjunction with the inline content, an error.fetch will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_DELAY

public static final java.lang.String ATTRIBUTE_DELAY

The character string returned is interpreted as a time interval. The send tag will return immediately, but the event is not dispatched until the delay interval elapses. Timers are useful for a wide variety of programming tasks, and can be implemented using this attribute. Note: The queue for sending events is maintained locally. Any events waiting to be sent will be purged when the session that issued this request terminates.

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 to configure the event processor. The meaning of these hints is specific to the implementing platform and the event processor.

See Also:

Constant Field Values

ATTRIBUTE_NAMELIST

public static final java.lang.String ATTRIBUTE_NAMELIST

A list of zero or more whitespace separated CCXML variable names to be included with the event. When an ECMAscript variable is included with the event, its value is first converted into a string. If the variable is an ECMAScript Object, the mechanism by which it is included is not currently defined. Instead of including ECMAScript Objects directly, the application developer may explicitly include the properties of an Object. e.g. "date.month date.year". If used in conjunction with the inline content, an error.fetch will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_SENDID

public static final java.lang.String ATTRIBUTE_SENDID

An ECMAScript left hand side expression evaluating to a previously defined variable. The value of the attribute will receive an internally generated unique string identifier to be associated with the event being sent. If this attribute is not specified, the event identifier is dropped.

See Also:

Constant Field Values

ATTRIBUTE_TARGET

public static final java.lang.String ATTRIBUTE_TARGET

An ECMAScript expression returning the target location of the event. The target attribute specifies the unique identifier of the event target that the Event I/O Processor should send the event to.

See Also:

Constant Field Values

ATTRIBUTE_TARGETTYPE

public static final java.lang.String ATTRIBUTE_TARGETTYPE

An ECMAScript expression which returns a character string that specifies the type of the Event I/O Processor that the event should be dispatched to.

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

Send

public Send()

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

getData

public java.lang.String getData()

Retrieve the data attribute.

Returns:

Value of the data attribute.

See Also:

ATTRIBUTE_DATA

setData

public void setData(java.lang.String data)

Set the data attribute.

Parameters:

data - Value of the data attribute.

See Also:

ATTRIBUTE_DATA

getDelay

public java.lang.String getDelay()

Retrieve the delay attribute.

Returns:

Value of the delay attribute.

See Also:

ATTRIBUTE_DELAY

setDelay

public void setDelay(java.lang.String delay)

Set the delay attribute.

Parameters:

delay - Value of the delay attribute.

See Also:

ATTRIBUTE_DELAY

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

getNamelist

public java.lang.String getNamelist()

Retrieve the namelist attribute.

Returns:

Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

setNamelist

public void setNamelist(java.lang.String namelist)

Set the namelist attribute.

Parameters:

namelist - Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

getSendid

public java.lang.String getSendid()

Retrieve the sendid attribute.

Returns:

Value of the sendid attribute.

See Also:

ATTRIBUTE_SENDID

setSendid

public void setSendid(java.lang.String sendid)

Set the sendid attribute.

Parameters:

sendid - Value of the sendid attribute.

See Also:

ATTRIBUTE_SENDID

getTarget

public java.lang.String getTarget()

Retrieve the target attribute.

Returns:

Value of the target attribute.

See Also:

ATTRIBUTE_TARGET

setTarget

public void setTarget(java.lang.String target)

Set the target attribute.

Parameters:

target - Value of the target attribute.

See Also:

ATTRIBUTE_TARGET

getTargettype

public java.lang.String getTargettype()

Retrieve the targettype attribute.

Returns:

Value of the targettype attribute.

See Also:

ATTRIBUTE_TARGETTYPE

setTargettype

public void setTargettype(java.lang.String targettype)

Set the targettype attribute.

Parameters:

targettype - Value of the targettype attribute.

See Also:

ATTRIBUTE_TARGETTYPE

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