class EppCommandPoll

This EppCommandPoll class implements EPP Command Poll entity.

Inheritance:


Public Fields

[more]static const char* OPTYPE_REQ
Poll operation type for polling existing messages (default)
[more]static const char* OPTYPE_ACK
Poll operation type for acknowledging the receiption of a message

Public Methods

[more] EppCommandPoll()
Creates an EppCommandPoll object, with default operation type as "req"
[more] EppCommandPoll( DOMString xid )
Creates an EppCommandPoll object, with default operation type as "req", given a client transaction id associated with operation
[more] EppCommandPoll( DOMString operation, DOMString messageId )
Creates an EppCommandPoll object, given the operation type and the message id.
[more] EppCommandPoll( DOMString operation, DOMString messageId, DOMString xid )
Creates an EppCommandPoll object, given the operation type and the message id and a client transaction id associated with operation
[more] ~EppCommandPoll()
Destructor
[more]virtual int getEntityType()
Returns the run-time type of an EppEntity object
[more]DOMString getOperation()
Gets the poll operation type
[more]void setOperation( DOMString operation )
Sets the poll operation type, either "req" or "ack"
[more]DOMString getMessageId()
Gets the message id related to the poll command
[more]void setMessageId( DOMString messageId )
Sets the message id related to the poll command
[more]DOM_Element toXML( DOM_Document& doc, const DOMString& tag )
Converts the EppCommandPoll object into an XML element
[more]static EppCommandPoll* fromXML( const DOM_Node& root )
Converts an XML element into an EppCommandPoll object.


Inherited from EppCommand:

Public Methods

oEppCreds* getCreds()
ovoid setCreds( EppCreds& creds )
oEppUnspec* getUnspec()
ovoid setUnspec( EppUnspec& unspec )
oDOMString getClientTransactionId()
ovoid setClientTransactionId( DOMString xid )
ostatic EppCommandCreate create( EppObject* object, DOMString xid )
ostatic EppCommandCheck* check( int objectType, DOMString xid )
ostatic EppCommandDelete* remove( int objectType, DOMString objectId, DOMString xid )
ostatic EppCommandInfo* info( int objectType, DOMString objectId, DOMString xid )
ostatic EppCommandUpdate* update( int objectType, DOMString objectId, DOMString xid )
ostatic EppCommandTransfer* transfer( int objectType, DOMString objectId, DOMString xid )
ostatic EppCommandRenew* renew( int objectType, DOMString objectId, DOMString xid )

Protected Fields

oEppCreds* creds
oEppUnspec* unspec
oDOMString clTRID

Protected Methods

oDOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element )
oDOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element, ValueVectorOf<DOM_Attr>* attrList )
oDOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, EppEntity* object )
oDOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element, EppEntity* object, const DOMString tag, ValueVectorOf<DOM_Attr>* attrList )


Inherited from EppEntity:

Public Methods

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

Protected Methods

oDOMString toString( const DOMString &tag )


Documentation

This EppCommandPoll class implements EPP Command Poll entity.

ostatic const char* OPTYPE_REQ
Poll operation type for polling existing messages (default)

ostatic const char* OPTYPE_ACK
Poll operation type for acknowledging the receiption of a message

o EppCommandPoll()
Creates an EppCommandPoll object, with default operation type as "req"

o EppCommandPoll( DOMString xid )
Creates an EppCommandPoll object, with default operation type as "req", given a client transaction id associated with operation

o EppCommandPoll( DOMString operation, DOMString messageId )
Creates an EppCommandPoll object, given the operation type and the message id.


Note: the operation type is either "req" for request, or "ack" for acknowledgement

o EppCommandPoll( DOMString operation, DOMString messageId, DOMString xid )
Creates an EppCommandPoll object, given the operation type and the message id and a client transaction id associated with operation


Note: the operation type is either "req" for request, or "ack" for acknowledgement

o ~EppCommandPoll()
Destructor

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

oDOMString getOperation()
Gets the poll operation type

ovoid setOperation( DOMString operation )
Sets the poll operation type, either "req" or "ack"

oDOMString getMessageId()
Gets the message id related to the poll command

ovoid setMessageId( DOMString messageId )
Sets the message id related to the poll command

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

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

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

Parameters:
root - root node for an EppCommandPoll object in XML format
Returns:
an EppCommandPoll 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-2002 NeuStar, Inc. All Rights Reserved.