ZeusBase-Library  2.0.4
zeus::IXMLMessage Class Referenceabstract

#include <IXMLMessage.hpp>

Inheritance diagram for zeus::IXMLMessage:
zeus::IMessage zeus::ISerializable zeus::IZUnknown zeus::TXMLMessage

Public Member Functions

virtual Retval MQUALIFIER getXMLDocument (NAMESPACE_Zeus::IXMLDocument *&rpDocument)=0
 
virtual Retval MQUALIFIER getXMLMainNode (NAMESPACE_Zeus::IXMLNode *&rpNode)=0
 
virtual void MQUALIFIER setXMLDocument (NAMESPACE_Zeus::IXMLDocument &rDocument)=0
 
- Public Member Functions inherited from zeus::IMessage
virtual void MQUALIFIER clearBody ()=0
 
virtual void MQUALIFIER clearProperties ()=0
 
virtual void MQUALIFIER getInterfaceID (InterfaceID &rIID) const =0
 
virtual Uint MQUALIFIER getMessageID () const =0
 
virtual Uint MQUALIFIER getPriority () const =0
 
virtual void MQUALIFIER getSender (TypGUID &rValue) const =0
 
virtual void MQUALIFIER getRecipients (IList< TypGUID > &rValue) const =0
 
virtual Retval MQUALIFIER getPropertyValue (const IString &rstrName, IString &rstrValue) const =0
 
virtual Uint64 MQUALIFIER getTimeStamp () const =0
 
virtual void MQUALIFIER setMessageID (Uint uiValue)=0
 
virtual void MQUALIFIER setPropertyValue (const IString &rstrName, const IString &rstrValue)=0
 
virtual void MQUALIFIER setPriority (Uint uiValue)=0
 
virtual void MQUALIFIER setSender (const TypGUID &rValue)=0
 
virtual void MQUALIFIER setRecipient (const TypGUID &rValue)=0
 
virtual void MQUALIFIER setRecipients (const IList< TypGUID > &rValue)=0
 
virtual void MQUALIFIER setTimeStamp (const Uint64 &rui64Value)=0
 
- Public Member Functions inherited from zeus::ISerializable
virtual Retval MQUALIFIER serialize (IByteArray &raStream) const =0
 
virtual Uint MQUALIFIER getObjectID () const =0
 
- Public Member Functions inherited from zeus::IZUnknown
virtual Retval MQUALIFIER askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)=0
 
virtual void MQUALIFIER addRef () const =0
 
virtual void MQUALIFIER release () const =0
 

Detailed Description

Marker Interface for simple XML message objects.

Member Function Documentation

§ getXMLDocument()

virtual Retval MQUALIFIER zeus::IXMLMessage::getXMLDocument ( NAMESPACE_Zeus::IXMLDocument *&  rpDocument)
pure virtual

Returns the XML document

Parameters
rpDocument: Document of the XML message body

Implemented in zeus::TXMLMessage.

§ getXMLMainNode()

virtual Retval MQUALIFIER zeus::IXMLMessage::getXMLMainNode ( NAMESPACE_Zeus::IXMLNode *&  rpNode)
pure virtual

Returns the reference of the XML Main Node.

Parameters
rpNode: Return parameter
Return values
RET_NOERROR: Node successfully returned
RET_REQUEST_FAILED: Could not return node

Implemented in zeus::TXMLMessage.

§ setXMLDocument()

virtual void MQUALIFIER zeus::IXMLMessage::setXMLDocument ( NAMESPACE_Zeus::IXMLDocument &  rDocument)
pure virtual

Sets the XML document

Parameters
rDocument: Document of the XML message body

Implemented in zeus::TXMLMessage.


The documentation for this class was generated from the following file:


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Tue Sep 13 2016 22:31:42