class EppObject

This EppObject class is the base class for all objects registered in the registry via the EPP Protocol.

Inheritance:

Public Fields

static const int CONTACT

Type for EPP Contact objcet

static const int DOMAIN

Type for EPP Domain object

static const int HOST

Type for EPP Host object

static const int SVCSUB

Type for EPP Svcsub object

Public Methods

EppObject()

Constructor

virtual ~EppObject()

Destructor

virtual int getEntityType()

Returns the run-time type of an EppEntity object

DOMString getRoid()

Gets ROID of the EppObject

void setRoid( DOMString roid )

Sets ROID of the EppObject

DOMString getClientId()

Gets the id of the registrar client sponsering the EppObject

void setClientId( DOMString clientId )

Sets the id of the registrar client sponsering the EppObject

DOMString getClientIdCreated()

Gets the id of the registrar client creating the EppObject initially

void setClientIdCreated( DOMString clientId )

Sets the id of the registrar client creating the EppObject initially

time_t getDateCreated()

Gets the date of the EppObject created

void setDateCreated( time_t cal )

Sets the date of the EppObject created

DOMString getClientIdUpdated()

Gets the id of the registrar client updating the EppObject most recently

void setClientIdUpdated( DOMString clientId )

Sets the id of the registrar client updating the EppObject most recently

time_t getDateUpdated()

Gets the date of the EppObject updated

void setDateUpdated( time_t cal )

Sets the date of the EppObject updated

time_t getDateExpired()

Gets the date of the EppObject expiration date

void setDateExpired( time_t cal )

Sets the expiration date of the EppObject

time_t getDateTransferred()

Gets the date of the EppObject transferred

void setDateTransferred( time_t cal )

Sets the date of the EppObject transferred

EppAuthInfo* getAuthInfo()

Gets the authorization info of the EppObject

void setAuthInfo( EppAuthInfo authInfo )

Sets the authorization info of the EppObject

ValueVectorOf<EppStatus> * getStatus()

Gets the status of the EppObject

void addStatus( EppStatus status )

Adds a status to the EppObject

static EppObject* fromXML( const DOM_Node& root )

Converts an XML element into an EppObject object

static EppCommandCreate create( EppObject* object, DOMString xid )

Creates an EppCommandCreate object for creating an EPP Object in the registry.

Protected Fields

DOMString roid

The ROID of the EPP Object in the registry

ValueVectorOf<EppStatus> * status

The status list associated with the EPP Object in the registry

DOMString clID

The id of the client that is sponsering the EPP Object

DOMString crID

The id of the client that created the EPP Object initially

time_t crDate

The timestamp when the EPP Object was created initially

DOMString upID

The id of the client that updated the EPP Object most recently

time_t upDate

The timestamp when the EPP Object was updated most recently

time_t exDate

The timestamp when the EPP Object is set to be expired

time_t trDate

The timestamp when the EPP Object was transferred most recently

EppAuthInfo* authInfo

The authorization information associated with the EPP object

Protected Methods

void fromXMLCommon( const DOM_Node& node, const DOMString name )

Converts shared EppObject components from XML

void toXMLCommon( DOM_Document& doc, DOM_Element& body )

Converts shared EppObject components into XML

void freeCommon()

Frees shared EppObject components

Inherited from EppEntity:

Public Methods

bool instanceOf( const int type )

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

virtual DOMString toString()

Protected Methods

DOMString toString( const DOMString &tag )

Documentation

This EppObject class is the base class for all objects registered in the registry via the EPP Protocol.

DOMString roid

The ROID of the EPP Object in the registry

ValueVectorOf<EppStatus> * status

The status list associated with the EPP Object in the registry

DOMString clID

The id of the client that is sponsering the EPP Object

DOMString crID

The id of the client that created the EPP Object initially

time_t crDate

The timestamp when the EPP Object was created initially

DOMString upID

The id of the client that updated the EPP Object most recently

time_t upDate

The timestamp when the EPP Object was updated most recently

time_t exDate

The timestamp when the EPP Object is set to be expired

Note: this field only applies to EPP Domain objects

time_t trDate

The timestamp when the EPP Object was transferred most recently

Note: this field does not apply to EPP Host objects

EppAuthInfo* authInfo

The authorization information associated with the EPP object

Note: this field does not apply to EPP Host objects

void fromXMLCommon( const DOM_Node& node, const DOMString name )

Converts shared EppObject components from XML

Parameters:

node - the node for a shared EppObject component
name - the name of the node for the shared EppObject component

void toXMLCommon( DOM_Document& doc, DOM_Element& body )

Converts shared EppObject components into XML

Parameters:

doc - the XML DOM_Element object
body - the XML DOM_Element to be attached

void freeCommon()

Frees shared EppObject components

static const int CONTACT

Type for EPP Contact objcet

static const int DOMAIN

Type for EPP Domain object

static const int HOST

Type for EPP Host object

static const int SVCSUB

Type for EPP Svcsub object

EppObject()

Constructor

virtual ~EppObject()

Destructor

virtual int getEntityType()

Returns the run-time type of an EppEntity object

DOMString getRoid()

Gets ROID of the EppObject

void setRoid( DOMString roid )

Sets ROID of the EppObject

DOMString getClientId()

Gets the id of the registrar client sponsering the EppObject

void setClientId( DOMString clientId )

Sets the id of the registrar client sponsering the EppObject

DOMString getClientIdCreated()

Gets the id of the registrar client creating the EppObject initially

void setClientIdCreated( DOMString clientId )

Sets the id of the registrar client creating the EppObject initially

time_t getDateCreated()

Gets the date of the EppObject created

void setDateCreated( time_t cal )

Sets the date of the EppObject created

DOMString getClientIdUpdated()

Gets the id of the registrar client updating the EppObject most recently

void setClientIdUpdated( DOMString clientId )

Sets the id of the registrar client updating the EppObject most recently

time_t getDateUpdated()

Gets the date of the EppObject updated

void setDateUpdated( time_t cal )

Sets the date of the EppObject updated

time_t getDateExpired()

Gets the date of the EppObject expiration date

Note: Currently, only an EPP domain object has an expiration date

void setDateExpired( time_t cal )

Sets the expiration date of the EppObject

Note: Currently, only an EPP domain object has an expiration date

time_t getDateTransferred()

Gets the date of the EppObject transferred

void setDateTransferred( time_t cal )

Sets the date of the EppObject transferred

EppAuthInfo* getAuthInfo()

Gets the authorization info of the EppObject

void setAuthInfo( EppAuthInfo authInfo )

Sets the authorization info of the EppObject

ValueVectorOf<EppStatus> * getStatus()

Gets the status of the EppObject

void addStatus( EppStatus status )

Adds a status to the EppObject

static EppObject* fromXML( const DOM_Node& root )

Converts an XML element into an EppObject object

Parameters:

root - root node for an EppObject object in XML format

static EppCommandCreate create( EppObject* object, DOMString xid )

Creates an EppCommandCreate object for creating an EPP Object in the registry.

Parameters:

object - the EPP Object to be created in the registry
xid - the client transaction id associated with the operation

Direct child classes:

EppSvcsub
EppHost
EppDomain
EppContact

Author:

Ning Zhang ning.zhang@neustar.com

Version:

$Revision: 1.2 $ $Date: 2006/05/20 14:45:13 $

Alphabetic index HTML hierarchy of classes or Java