com.virtualweaver.xotics.dialect.xape.engine
Class XapRequest

java.lang.Object
  extended bycom.virtualweaver.xotics.datamodel.XoObjectSupport
      extended bycom.virtualweaver.xotics.datamodel.XoContainerSupport
          extended bycom.virtualweaver.xotics.dialect.xape.engine.XapMessage
              extended bycom.virtualweaver.xotics.dialect.xape.engine.XapRequest
All Implemented Interfaces:
java.lang.Cloneable, com.virtualweaver.xotics.datamodel.XoContainer, com.virtualweaver.xotics.datamodel.XoNode, com.virtualweaver.xotics.datamodel.XoObject

public class XapRequest
extends XapMessage

This class is a request version of a XAPE message. As XO container, it's a root element for every XAPE request message which has the following format : *

 <ctx:request>
 	<ctx:content>
 		<any:contentObject>
 	</ctx:content>
 	<ctx:response>
 		<any:response-content>
	</ctx:response>
 </ctx:request>
where : property system tells whether this is a system message, a message generated by the engine itself for itself. properties appName and instanceName identify a particular application instance. property handler contains the ID of an element in the current state, or a special ID to precise a system message, depending on value of property system. responseQueue contains the queue used to receive the response if any.

Version:
2.1

Field Summary
 
Fields inherited from class com.virtualweaver.xotics.datamodel.XoContainerSupport
containerEventSupport
 
Fields inherited from class com.virtualweaver.xotics.datamodel.XoObjectSupport
propertyChangeSupport, vetoableChangeSupport
 
Constructor Summary
XapRequest()
           
 
Method Summary
 java.lang.Object clone()
           
 java.lang.String getAppName()
           
 java.lang.String getHandler()
           
 java.lang.String getInstanceName()
           
 XapResponse getResponse()
           
 XapQueue getResponseQueue()
           
 boolean isSystem()
           
 boolean isXoPropertyToWrite(java.lang.String pname)
           
 void setAppName(java.lang.String appName)
           
 void setHandler(java.lang.String handler)
           
 void setInstanceName(java.lang.String instanceName)
           
 void setResponseQueue(XapQueue responseQueue)
           
 void setSystem(boolean system)
           
 
Methods inherited from class com.virtualweaver.xotics.dialect.xape.engine.XapMessage
checkXoValidity, clone, getId, getType, setId, setType
 
Methods inherited from class com.virtualweaver.xotics.datamodel.XoContainerSupport
addXoChild, addXoContainerListener, getXoChildren, getXoChildren, getXoChildrenCount, getXoContainerListeners, getXoContentModel, isXoObjectWelcome, removeXoChild, removeXoContainerListener
 
Methods inherited from class com.virtualweaver.xotics.datamodel.XoObjectSupport
addPropertyChangeListener, addVetoableChangeListener, clone, equalsXoObject, getLocale, getXmlLocalName, getXmlNameSpace, getXmlWhiteSpace, getXoDMInstance, getXoParent, removePropertyChangeListener, removeVetoableChangeListener, setIntegrated, setLocale, setXmlLocalName, setXmlNameSpace, setXmlWhiteSpace, setXoDMInstance, setXoParent, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.virtualweaver.xotics.datamodel.XoObject
addPropertyChangeListener, addVetoableChangeListener, equalsXoObject, getLocale, getXmlLocalName, getXmlNameSpace, getXmlWhiteSpace, getXoDMInstance, getXoParent, removePropertyChangeListener, removeVetoableChangeListener, setIntegrated, setLocale, setXmlLocalName, setXmlNameSpace, setXmlWhiteSpace, setXoDMInstance, setXoParent
 

Constructor Detail

XapRequest

public XapRequest()
Method Detail

isSystem

public boolean isSystem()

setSystem

public void setSystem(boolean system)
               throws java.beans.PropertyVetoException
Throws:
java.beans.PropertyVetoException

getAppName

public java.lang.String getAppName()

setAppName

public void setAppName(java.lang.String appName)
                throws java.beans.PropertyVetoException
Throws:
java.beans.PropertyVetoException

getInstanceName

public java.lang.String getInstanceName()

setInstanceName

public void setInstanceName(java.lang.String instanceName)
                     throws java.beans.PropertyVetoException
Throws:
java.beans.PropertyVetoException

getResponseQueue

public XapQueue getResponseQueue()

setResponseQueue

public void setResponseQueue(XapQueue responseQueue)
                      throws java.beans.PropertyVetoException
Throws:
java.beans.PropertyVetoException

getHandler

public java.lang.String getHandler()

setHandler

public void setHandler(java.lang.String handler)
                throws java.beans.PropertyVetoException
Throws:
java.beans.PropertyVetoException

getResponse

public XapResponse getResponse()

isXoPropertyToWrite

public boolean isXoPropertyToWrite(java.lang.String pname)
Specified by:
isXoPropertyToWrite in interface com.virtualweaver.xotics.datamodel.XoObject
Overrides:
isXoPropertyToWrite in class XapMessage

clone

public java.lang.Object clone()
Specified by:
clone in interface com.virtualweaver.xotics.datamodel.XoObject
Overrides:
clone in class XapMessage