org.jvoicexml.xml.ccxml
Class Move

java.lang.Object
  extended by org.jvoicexml.xml.AbstractXmlNode
      extended by org.jvoicexml.xml.ccxml.Move
All Implemented Interfaces:
CcxmlNode, XmlNode, Node

public final class Move
extends AbstractXmlNode

<move> is used to move an event source (such as a Connection object) to an executing CCXML session. When an event source is moved to a session, events originating from that source will be delivered to that session's currently executing CCXML document. The event OR the source attribute MUST be specified. If neither attribute is specified or both attributes are specified, an error.fetch event will be thrown.

Version:
$Revision: 2325 $

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

Author:
Steve Doyle

Field Summary
static String ATTRIBUTE_EVENT
          The event source from which the event object originated, if any, will be moved to the target session.
protected static ArrayList<String> ATTRIBUTE_NAMES
          Supported attribute names for this node.
static String ATTRIBUTE_SESSIONID
          An ECMAScript expression that identifies the session to which the event source will be moved.
static String ATTRIBUTE_SOURCE
          An ECMAScript expression which returns a connectionID or dialogID.
static 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
Move()
          Construct a new move object without a node.
 
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 getEvent()
          Retrieve the event attribute.
 String getSessionid()
          Retrieve the sessionid attribute.
 String getSource()
          Retrieve the source attribute.
 String getTagName()
          Get the name of the tag for the derived node.
 XmlNode newInstance(Node n, XmlNodeFactory<? extends XmlNode> factory)
          Create a new instance for the given node.
 void setEvent(String event)
          Set the event attribute.
 void setSessionid(String sessionid)
          Set the sessionid attribute.
 void setSource(String source)
          Set the source 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, 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 String TAG_NAME
Name of the tag.

See Also:
Constant Field Values

ATTRIBUTE_EVENT

public static final String ATTRIBUTE_EVENT
The event source from which the event object originated, if any, will be moved to the target session. The event will also be sent to the target session to provide a notification. Either the source or the event attribute has to be specified. If neither of them is specified, or if both are specified, an error.fetch event will be thrown.

See Also:
Constant Field Values

ATTRIBUTE_SESSIONID

public static final String ATTRIBUTE_SESSIONID
An ECMAScript expression that identifies the session to which the event source will be moved.

See Also:
Constant Field Values

ATTRIBUTE_SOURCE

public static final String ATTRIBUTE_SOURCE
An ECMAScript expression which returns a connectionID or dialogID. The event source associated with this identifier will be moved to the target session. Either the source or the event attribute has to be specified. If neither of them is specified, or if both are specified, an error.fetch event will be thrown. 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.

Constructor Detail

Move

public Move()
Construct a new move object without a node.

This is necessary for the node factory.

See Also:
VoiceXmlNodeFactory
Method Detail

getTagName

public String getTagName()
Get the name of the tag for the derived node.

Returns:
name of the tag.

newInstance

public XmlNode newInstance(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

getEvent

public String getEvent()
Retrieve the event attribute.

Returns:
Value of the event attribute.
See Also:
ATTRIBUTE_EVENT

setEvent

public void setEvent(String event)
Set the event attribute.

Parameters:
event - Value of the event attribute.
See Also:
ATTRIBUTE_EVENT

getSessionid

public String getSessionid()
Retrieve the sessionid attribute.

Returns:
Value of the sessionid attribute.
See Also:
ATTRIBUTE_SESSIONID

setSessionid

public void setSessionid(String sessionid)
Set the sessionid attribute.

Parameters:
sessionid - Value of the sessionid attribute.
See Also:
ATTRIBUTE_SESSIONID

getSource

public String getSource()
Retrieve the source attribute.

Returns:
Value of the source attribute.
See Also:
ATTRIBUTE_SOURCE

setSource

public void setSource(String source)
Set the source attribute.

Parameters:
source - Value of the source attribute.
See Also:
ATTRIBUTE_SOURCE

canContainChild

protected boolean canContainChild(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 Collection<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


Copyright © 2005-2009JVoiceXML group.