class EppContact

This EppContact class implements EPP Contact objects.

Inheritance:


Public Fields

[more]static const char* STATUS_CLIENT_DELETE_PROHIBITED
Contact status - clientDeleteProhibited
[more]static const char* STATUS_CLIENT_TRANSFER_PROHIBITED
Contact status - clientTransferProhibited
[more]static const char* STATUS_CLIENT_UPDATE_PROHIBITED
Contact status - clientUpdateProhibited
[more]static const char* STATUS_LINKED
Contact status - linked
[more]static const char* STATUS_OK
Contact status - ok
[more]static const char* STATUS_PENDING_DELETE
Contact status - pendingDelete
[more]static const char* STATUS_PENDING_TRANSFER
Contact status - pendingTransfer
[more]static const char* STATUS_SERVER_DELETE_PROHIBITED
Contact status - serverDeleteProhibited
[more]static const char* STATUS_SERVER_TRANSFER_PROHIBITED
Contact status - serverTransferProhibited
[more]static const char* STATUS_SERVER_UPDATE_PROHIBITED
Contact status - serverUpdateProhibited

Public Methods

[more] EppContact()
Creates an EppContact object
[more] EppContact( DOMString id )
Creates an EppContact object, with a contact id
[more] ~EppContact()
Destructor
[more]virtual int getEntityType()
Returns the run-time type of an EppEntity object
[more]DOMString getId()
Gets the contact id
[more]void setId( DOMString id )
Sets the contact id
[more]EppContactData* getContactDataAscii()
Gets the contact data in ascii encoding
[more]void setContactDataAscii( EppContactData& ascii )
Sets the contact data in ascii encoding
[more]EppContactData* getContactDataI15d()
Gets the contact data in native encoding
[more]void setContactDataI15d( EppContactData& i15d )
Sets the contact data in native encoding
[more]EppE164* getVoice()
Gets the voice phone number of the contact
[more]void setVoice( DOMString voice )
Sets the voice phone number of the contact
[more]void setVoice( DOMString voice, DOMString ext )
Sets the voice phone number and extenstion
[more]void setVoice( EppE164 voice )
Sets the voice phone number of the contact
[more]EppE164* getFax()
Gets the fax number of the contact
[more]void setFax( DOMString fax )
Sets the fax number of the contact
[more]void setFax( DOMString fax, DOMString ext )
Sets the fax number and extenstion
[more]void setFax( EppE164 fax )
Sets the fax number extension
[more]DOMString getEmail()
Gets the email address of the contact
[more]void setEmail( DOMString email )
Sets the email address of the contact
[more]DOM_Element toXML( DOM_Document& doc, const DOMString& tag )
Converts the EppContact object into an XML element
[more]static EppContact* fromXML( const DOM_Node& root )
Converts an XML element into an EppContact object.
[more]static EppCommandDeleteContact remove( DOMString id, DOMString xid )
Creates an EppCommandDeleteContact object for deleting an EPP Contact object from the registry.
[more]static EppCommandInfoContact info( DOMString id, DOMString xid )
Creates an EppCommandInfoContact object for querying the details of an EPP Contact object
[more]static EppCommandCheckContact check( DOMString xid )
Creates an EppCommandCheckContact object for checking the existance of EPP Contact objects in the registry.
[more]static EppCommandTransferContact transfer( DOMString id, DOMString xid )
Creates an EppCommandTransferContact object for transfering an EPP Contact object in the registry.
[more]static EppCommandUpdateContact update( DOMString id, DOMString xid )
Creates an EppCommandUpdateContact object for updating an EPP Contact object in the registry.


Inherited from EppObject:

Public Fields

ostatic const int CONTACT
ostatic const int DOMAIN
ostatic const int HOST

Public Methods

oDOMString getRoid()
ovoid setRoid( DOMString roid )
oDOMString getClientId()
ovoid setClientId( DOMString clientId )
oDOMString getClientIdCreated()
ovoid setClientIdCreated( DOMString clientId )
otime_t getDateCreated()
ovoid setDateCreated( time_t cal )
oDOMString getClientIdUpdated()
ovoid setClientIdUpdated( DOMString clientId )
otime_t getDateUpdated()
ovoid setDateUpdated( time_t cal )
otime_t getDateExpired()
ovoid setDateExpired( time_t cal )
otime_t getDateTransferred()
ovoid setDateTransferred( time_t cal )
oEppAuthInfo* getAuthInfo()
ovoid setAuthInfo( EppAuthInfo authInfo )
oValueVectorOf<EppStatus> * getStatus()
ovoid addStatus( EppStatus status )
ostatic EppCommandCreate create( EppObject* object, DOMString xid )

Protected Fields

oDOMString roid
oValueVectorOf<EppStatus> * status
oDOMString clID
oDOMString crID
otime_t crDate
oDOMString upID
otime_t upDate
otime_t exDate
otime_t trDate
oEppAuthInfo* authInfo

Protected Methods

ovoid fromXMLCommon( const DOM_Node& node, const DOMString name )
ovoid toXMLCommon( DOM_Document& doc, DOM_Element& body )
ovoid freeCommon()


Inherited from EppEntity:

Public Methods

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

Protected Methods

oDOMString toString( const DOMString &tag )


Documentation

This EppContact class implements EPP Contact objects.

ostatic const char* STATUS_CLIENT_DELETE_PROHIBITED
Contact status - clientDeleteProhibited

ostatic const char* STATUS_CLIENT_TRANSFER_PROHIBITED
Contact status - clientTransferProhibited

ostatic const char* STATUS_CLIENT_UPDATE_PROHIBITED
Contact status - clientUpdateProhibited

ostatic const char* STATUS_LINKED
Contact status - linked

ostatic const char* STATUS_OK
Contact status - ok

ostatic const char* STATUS_PENDING_DELETE
Contact status - pendingDelete

ostatic const char* STATUS_PENDING_TRANSFER
Contact status - pendingTransfer

ostatic const char* STATUS_SERVER_DELETE_PROHIBITED
Contact status - serverDeleteProhibited

ostatic const char* STATUS_SERVER_TRANSFER_PROHIBITED
Contact status - serverTransferProhibited

ostatic const char* STATUS_SERVER_UPDATE_PROHIBITED
Contact status - serverUpdateProhibited

o EppContact()
Creates an EppContact object

o EppContact( DOMString id )
Creates an EppContact object, with a contact id

o ~EppContact()
Destructor

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

oDOMString getId()
Gets the contact id

ovoid setId( DOMString id )
Sets the contact id

oEppContactData* getContactDataAscii()
Gets the contact data in ascii encoding

ovoid setContactDataAscii( EppContactData& ascii )
Sets the contact data in ascii encoding

oEppContactData* getContactDataI15d()
Gets the contact data in native encoding

ovoid setContactDataI15d( EppContactData& i15d )
Sets the contact data in native encoding

oEppE164* getVoice()
Gets the voice phone number of the contact

ovoid setVoice( DOMString voice )
Sets the voice phone number of the contact

ovoid setVoice( DOMString voice, DOMString ext )
Sets the voice phone number and extenstion

ovoid setVoice( EppE164 voice )
Sets the voice phone number of the contact

oEppE164* getFax()
Gets the fax number of the contact

ovoid setFax( DOMString fax )
Sets the fax number of the contact

ovoid setFax( DOMString fax, DOMString ext )
Sets the fax number and extenstion

ovoid setFax( EppE164 fax )
Sets the fax number extension

oDOMString getEmail()
Gets the email address of the contact

ovoid setEmail( DOMString email )
Sets the email address of the contact

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

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

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

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

ostatic EppCommandDeleteContact remove( DOMString id, DOMString xid )
Creates an EppCommandDeleteContact object for deleting an EPP Contact object from the registry.

Parameters:
id - the id of the contact object to be deleted
xid - the client transaction id associated with the operation

ostatic EppCommandInfoContact info( DOMString id, DOMString xid )
Creates an EppCommandInfoContact object for querying the details of an EPP Contact object

Parameters:
id - the id of the contact object to be queried
xid - the client transaction id associated with the operation

ostatic EppCommandCheckContact check( DOMString xid )
Creates an EppCommandCheckContact object for checking the existance of EPP Contact objects in the registry. ids of EPP Contact objects can be added via the add or addRoid methods.

Parameters:
xid - the client transaction id associated with the operation

ostatic EppCommandTransferContact transfer( DOMString id, DOMString xid )
Creates an EppCommandTransferContact object for transfering an EPP Contact object in the registry. The operation type and authorization information associated with the operation should be specified via setOperation and setAuthInfo method.

Parameters:
id - the id of the contact object to be transferred
xid - the client transaction id associated with the operation

ostatic EppCommandUpdateContact update( DOMString id, DOMString xid )
Creates an EppCommandUpdateContact object for updating an EPP Contact object in the registry. The actual update information should be specified via the various methods defined for the EppCommandUpdateContact object.

Parameters:
id - the id of the contact object to be updated
xid - the client transaction id associated with the operation


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.