class EppEntity

The EppEntity class is the base class for all entities/objects defined for EPP.

Inheritance:

Public Methods

[more] EppEntity()
Constructor
[more]virtual ~EppEntity() = 0
Destructor
[more]virtual int getEntityType()
Returns the run-time type of an EppEntity object
[more]bool instanceOf( const int type )
Checks if an EppEntity object is an instance of an specific object type
[more]static EppEntity* fromXML( const DOM_Node &root )
Converts an XML element into an EppEntity object.
[more]virtual DOM_Element toXML( DOM_Document &doc, const DOMString &tag ) = 0
Converts the EppEntity object into an XML element
[more]virtual DOMString toString() = 0
Converts the EppEntity object into plain XML text string by using the default root tag name

Protected Methods

[more]DOMString toString( const DOMString &tag )
Converts the EppEntity object into plain XML text string

Documentation

The EppEntity class is the base class for all entities/objects defined for EPP. All subclasses of EppEntity need to implement the following three methods:

o TYPE_EppEntity
Defines EPP Entity type constants to be used for determining the EPP object type at run-time. Each EPP Entity type correspondes to the same class name in the foramt of TYPE_EppClassName. If an EPP Entity is not defined below, its default type is TYPE_EppEntity. If a constant does not corrspondes to an EPP Entity, it is used internally. These constants are used in the getEntityType() and instanceOf() methods.

See Also:
getEntityType
instanceOf 
static const int TYPE_EppEntity                      
static const int TYPE_EppObject                      
static const int TYPE_EppContact                     
static const int TYPE_EppDomain                      
static const int TYPE_EppHost                        
static const int TYPE_EppSvcsub                      
static const int TYPE_EppCommand                     
static const int TYPE_EppCommandPoll                 
static const int TYPE_EppCommandLogin                
static const int TYPE_EppCommandLogout               
static const int TYPE_EppCommandCreate               
static const int TYPE_EppCommandCheck                
static const int TYPE_EppCommandCheckContact         
static const int TYPE_EppCommandCheckDomain          
static const int TYPE_EppCommandCheckHost            
static const int TYPE_EppCommandCheckSvcsub          
static const int TYPE_EppCommandDelete               
static const int TYPE_EppCommandDeleteContact        
static const int TYPE_EppCommandDeleteDomain         
static const int TYPE_EppCommandDeleteHost           
static const int TYPE_EppCommandDeleteSvcsub         
static const int TYPE_EppCommandInfo                 
static const int TYPE_EppCommandInfoContact          
static const int TYPE_EppCommandInfoDomain           
static const int TYPE_EppCommandInfoHost             
static const int TYPE_EppCommandInfoSvcsub           
static const int TYPE_EppCommandUpdate               
static const int TYPE_EppCommandUpdateContact        
static const int TYPE_EppCommandUpdateDomain         
static const int TYPE_EppCommandUpdateHost           
static const int TYPE_EppCommandUpdateSvcsub         
static const int TYPE_EppCommandRenew                
static const int TYPE_EppCommandRenewContact         
static const int TYPE_EppCommandRenewDomain          
static const int TYPE_EppCommandRenewHost            
static const int TYPE_EppCommandRenewSvcsub          
static const int TYPE_EppCommandTransfer             
static const int TYPE_EppCommandTransferContact      
static const int TYPE_EppCommandTransferDomain       
static const int TYPE_EppCommandTransferHost         
static const int TYPE_EppCommandTransferSvcsub       
static const int TYPE_EppResponse                    
static const int TYPE_EppResponseData                
static const int TYPE_EppResponseDataPoll            
static const int TYPE_EppResponseDataInfo            
static const int TYPE_EppResponseDataCreate          
static const int TYPE_EppResponseDataCreateContact   
static const int TYPE_EppResponseDataCreateDomain    
static const int TYPE_EppResponseDataCreateHost      
static const int TYPE_EppResponseDataCreateSvcsub    
static const int TYPE_EppResponseDataCheck           
static const int TYPE_EppResponseDataCheckContact    
static const int TYPE_EppResponseDataCheckDomain     
static const int TYPE_EppResponseDataCheckHost       
static const int TYPE_EppResponseDataCheckSvcsub     
static const int TYPE_EppResponseDataTransfer        
static const int TYPE_EppResponseDataTransferContact 
static const int TYPE_EppResponseDataTransferDomain  
static const int TYPE_EppResponseDataTransferHost    
static const int TYPE_EppResponseDataTransferSvcsub

o EppEntity()
Constructor

ovirtual ~EppEntity() = 0
Destructor

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

See Also:
TYPE_EppEntity

obool instanceOf( const int type )
Checks if an EppEntity object is an instance of an specific object type

See Also:
TYPE_EppEntity

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

Parameters:
root - root node for an EppEntity object in XML format
Returns:
a pointer to an EppEntity object, or null if the node is invalid
Note: the caller should free the object

ovirtual DOM_Element toXML( DOM_Document &doc, const DOMString &tag ) = 0
Converts the EppEntity object into an XML element

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

ovirtual DOMString toString() = 0
Converts the EppEntity object into plain XML text string by using the default root tag name

Returns:
a text string representing the EppEntity object in XML format

oDOMString toString( const DOMString &tag )
Converts the EppEntity object into plain XML text string

Parameters:
tag - XML tag name for the root node
Returns:
a text string representing the EppEntity object in XML format

Direct child classes:
EppUnspec
EppTransactionId
EppSvcsubParam
EppStatus
EppServiceMenu
EppResultMessage
EppResult
EppResponseData
EppResponse
EppPeriod
EppObject
EppIpAddress
EppHello
EppGreeting
EppE164
EppCredsOptions
EppCreds
EppContactType
EppContactData
EppCommand
EppAuthInfo
EppAddress
Author:
Ning Zhang ning.zhang@neustar.com
Version:
$Revision: 1.2 $ $Date: 2007/09/04 21:34:35 $

Alphabetic index HTML hierarchy of classes or Java

Copyright © 2001-2002 NeuLevel, Inc. All Rights Reserved.