class EppResponse

This EppResponse class implements EPP Response entity.

Inheritance:


Public Methods

[more] EppResponse()
Creates an EppResponse object
[more] ~EppResponse()
Destructor
[more]virtual int getEntityType()
Returns the run-time type of an EppEntity object
[more]ValueVectorOf<EppResult *> * getResult()
Gets result
[more]void addResult( EppResult* result )
Adds a result object
[more]void addResult( EppResult& result )
Adds a result object
[more]int getMessageQueued()
Gets number of messages queued
[more]void setMessageQueued( int number )
Sets number of messages queued
[more]time_t getMessageQueueUpdated()
Gets the timestamp of the message queue updated by the server
[more]void setMessageQueueUpdated( time_t cal )
Sets the timestamp of the message queue updated by the server
[more]EppResponseData* getResponseData()
Gets response data
[more]void setResponseData( EppResponseData* data )
Sets response data
[more]EppUnspec* getUnspec()
Gets optional unspecified object
[more]void setUnspec( EppUnspec& unspec )
Sets optional unspecified object
[more]EppTransactionId* getTransactionId()
Gets transaction id from the registrar client
[more]void setTransactionId( EppTransactionId& xid )
Sets transaction id
[more]bool success()
Checks if the EPP Response is for a completed operation without any error
[more]DOM_Element toXML( DOM_Document& doc, const DOMString& tag )
Converts the EppResponse object into an XML element
[more]static EppResponse* fromXML( const DOM_Node& root )
Converts an XML element into an EppResponse object.


Inherited from EppEntity:

Public Methods

obool instanceOf( const int type )
ovirtual DOMString toString()

Protected Methods

oDOMString toString( const DOMString &tag )


Documentation

This EppResponse class implements EPP Response entity.

o EppResponse()
Creates an EppResponse object

o ~EppResponse()
Destructor

ovirtual int getEntityType()
Returns the run-time type of an EppEntity object

oValueVectorOf<EppResult *> * getResult()
Gets result

ovoid addResult( EppResult* result )
Adds a result object

ovoid addResult( EppResult& result )
Adds a result object

oint getMessageQueued()
Gets number of messages queued

ovoid setMessageQueued( int number )
Sets number of messages queued

otime_t getMessageQueueUpdated()
Gets the timestamp of the message queue updated by the server

ovoid setMessageQueueUpdated( time_t cal )
Sets the timestamp of the message queue updated by the server

oEppResponseData* getResponseData()
Gets response data

ovoid setResponseData( EppResponseData* data )
Sets response data


Note: the memory associated with the response data will not be freed by this class. The caller of this method should be responsible to free the memory, if needed.

oEppUnspec* getUnspec()
Gets optional unspecified object

ovoid setUnspec( EppUnspec& unspec )
Sets optional unspecified object

oEppTransactionId* getTransactionId()
Gets transaction id from the registrar client

ovoid setTransactionId( EppTransactionId& xid )
Sets transaction id

obool success()
Checks if the EPP Response is for a completed operation without any error

oDOM_Element toXML( DOM_Document& doc, const DOMString& tag )
Converts the EppResponse object into an XML element

Parameters:
doc - the XML DOM_Element object
tag - the tag/element name for the EppResponse object
Returns:
an DOM_Element object

ostatic EppResponse* fromXML( const DOM_Node& root )
Converts an XML element into an EppResponse object. The caller of this method must make sure that the root node is of the EPP responseType.

Parameters:
root - root node for an EppResponse object in XML format
Returns:
an EppResponse object, or null if the node is invalid


This class has no child classes.
Author:
Ning Zhang ning.zhang@neustar.com
Version:
$Revision: 1.1 $ $Date: 2001/11/05 20:20:36 $

Alphabetic index HTML hierarchy of classes or Java


Copyright © 2001 NeuStar, Inc. All Rights Reserved.