class EppResponse

This EppResponse class implements EPP Response entity.

Inheritance:

Public Methods

EppResponse()

Creates an EppResponse object

~EppResponse()

Destructor

virtual int getEntityType()

Returns the run-time type of an EppEntity object

ValueVectorOf<EppResult *> * getResult()

Gets result

void addResult( EppResult* result )

Adds a result object

void addResult( EppResult& result )

Adds a result object

int getMessageQueued()

Gets number of messages queued

void setMessageQueued( int number )

Sets number of messages queued

time_t getMessageQueueUpdated()

Gets the timestamp of the message queue updated by the server

void setMessageQueueUpdated( time_t cal )

Sets the timestamp of the message queue updated by the server

EppResponseData* getResponseData()

Gets response data

void setResponseData( EppResponseData* data )

Sets response data

EppUnspec* getUnspec()

Gets optional unspecified object

void setUnspec( EppUnspec& unspec )

Sets optional unspecified object

EppTransactionId* getTransactionId()

Gets transaction id from the registrar client

void setTransactionId( EppTransactionId& xid )

Sets transaction id

bool success()

Checks if the EPP Response is for a completed operation without any error

DOM_Element toXML( DOM_Document& doc, const DOMString& tag )

Converts the EppResponse object into an XML element

static EppResponse* fromXML( const DOM_Node& root )

Converts an XML element into an EppResponse object.

Inherited from EppEntity:

Public Methods

bool instanceOf( const int type )

virtual DOMString toString()

Protected Methods

DOMString toString( const DOMString &tag )

Documentation

This EppResponse class implements EPP Response entity.

EppResponse()

Creates an EppResponse object

~EppResponse()

Destructor

virtual int getEntityType()

Returns the run-time type of an EppEntity object

ValueVectorOf<EppResult *> * getResult()

Gets result

void addResult( EppResult* result )

Adds a result object

void addResult( EppResult& result )

Adds a result object

int getMessageQueued()

Gets number of messages queued

void setMessageQueued( int number )

Sets number of messages queued

time_t getMessageQueueUpdated()

Gets the timestamp of the message queue updated by the server

void setMessageQueueUpdated( time_t cal )

Sets the timestamp of the message queue updated by the server

EppResponseData* getResponseData()

Gets response data

void 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.

EppUnspec* getUnspec()

Gets optional unspecified object

void setUnspec( EppUnspec& unspec )

Sets optional unspecified object

EppTransactionId* getTransactionId()

Gets transaction id from the registrar client

void setTransactionId( EppTransactionId& xid )

Sets transaction id

bool success()

Checks if the EPP Response is for a completed operation without any error

DOM_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

static 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