com.neulevel.epp.core
Class EppContact

java.lang.Object
  |
  +--com.neulevel.epp.core.EppEntity
        |
        +--com.neulevel.epp.core.EppObject
              |
              +--com.neulevel.epp.core.EppContact

public class EppContact

extends EppObject

This EppContact class implements EPP Contact objects.

Version:

$Revision$ $Date$

Author:

Ning Zhang ning.zhang@neustar.com

Field Summary

static java.lang.String	STATUS_CLIENT_DELETE_PROHIBITED Contact status - clientDeleteProhibited
static java.lang.String	STATUS_CLIENT_TRANSFER_PROHIBITED Contact status - clientTransferProhibited
static java.lang.String	STATUS_CLIENT_UPDATE_PROHIBITED Contact status - clientUpdateProhibited
static java.lang.String	STATUS_LINKED Contact status - linked
static java.lang.String	STATUS_OK Contact status - ok
static java.lang.String	STATUS_PENDING_DELETE Contact status - pendingDelete
static java.lang.String	STATUS_PENDING_TRANSFER Contact status - pendingTransfer
static java.lang.String	STATUS_SERVER_DELETE_PROHIBITED Contact status - serverDeleteProhibited
static java.lang.String	STATUS_SERVER_TRANSFER_PROHIBITED Contact status - serverTransferProhibited
static java.lang.String	STATUS_SERVER_UPDATE_PROHIBITED Contact status - serverUpdateProhibited

Fields inherited from class com.neulevel.epp.core.EppObject

authInfo, clID, CONTACT, crDate, crID, DOMAIN, exDate, HOST, roid, status, trDate, upDate, upID

Constructor Summary

EppContact()
Creates an EppContact object

EppContact(java.lang.String id)
Creates an EppContact object with a client-supplied contact id

Method Summary

static EppCommandCheckContact	check(java.lang.String xid) Creates an EppCommandCheckContact object for checking the existance of EPP Contact objects in the registry.
static EppCommandDeleteContact	delete(java.lang.String id, java.lang.String xid) Creates an EppCommandDeleteContact object for deleting an EPP Contact object from the registry.
static EppEntity	fromXML(org.w3c.dom.Node root) Converts an XML element into an EppContact object.
EppContactData	getContactDataAscii() Gets the contact data in ascii encoding
EppContactData	getContactDataI15d() Gets the contact data in native encoding
java.lang.String	getEmail() Gets the email address of the contact
EppE164	getFax() Gets the fax number of the contact
java.lang.String	getId() Gets the contact id
EppE164	getVoice() Gets the voice phone number of the contact
static EppCommandInfoContact	info(java.lang.String id, java.lang.String xid) Creates an EppCommandInfoContact object for querying the details of an EPP Contact object
void	setContactDataAscii(EppContactData ascii) Sets the contact data in ascii encoding
void	setContactDataI15d(EppContactData i15d) Sets the contact data in native encoding
void	setEmail(java.lang.String email) Sets the email address of the contact
void	setFax(EppE164 fax) Sets the fax number extension
void	setFax(java.lang.String fax) Sets the fax number of the contact
void	setFax(java.lang.String fax, java.lang.String ext) Sets the fax number and extenstion
void	setId(java.lang.String id) Sets the contact id
void	setVoice(EppE164 voice) Sets the voice phone number of the contact
void	setVoice(java.lang.String voice) Sets the voice phone number of the contact
void	setVoice(java.lang.String voice, java.lang.String ext) Sets the voice phone number and extenstion
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc, java.lang.String tag) Converts the EppContact object into an XML element
static EppCommandTransferContact	transfer(java.lang.String id, java.lang.String xid) Creates an EppCommandTransferContact object for transfering an EPP Contact object in the registry.
static EppCommandUpdateContact	update(java.lang.String id, java.lang.String xid) Creates an EppCommandUpdateContact object for updating an EPP Contact object in the registry.

Methods inherited from class com.neulevel.epp.core.EppObject

addStatus, create, fromXMLCommon, getAuthInfo, getClientId, getClientIdCreated, getClientIdUpdated, getDateCreated, getDateExpired, getDateTransferred, getDateUpdated, getRoid, getStatus, setAuthInfo, setClientId, setClientIdCreated, setClientIdUpdated, setDateCreated, setDateExpired, setDateTransferred, setDateUpdated, setRoid, toXMLCommon

Methods inherited from class com.neulevel.epp.core.EppEntity

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATUS_CLIENT_DELETE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_DELETE_PROHIBITED

Contact status - clientDeleteProhibited

STATUS_CLIENT_TRANSFER_PROHIBITED

public static final java.lang.String STATUS_CLIENT_TRANSFER_PROHIBITED

Contact status - clientTransferProhibited

STATUS_CLIENT_UPDATE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_UPDATE_PROHIBITED

Contact status - clientUpdateProhibited

STATUS_LINKED

public static final java.lang.String STATUS_LINKED

Contact status - linked

STATUS_OK

public static final java.lang.String STATUS_OK

Contact status - ok

STATUS_PENDING_DELETE

public static final java.lang.String STATUS_PENDING_DELETE

Contact status - pendingDelete

STATUS_PENDING_TRANSFER

public static final java.lang.String STATUS_PENDING_TRANSFER

Contact status - pendingTransfer

STATUS_SERVER_DELETE_PROHIBITED

public static final java.lang.String STATUS_SERVER_DELETE_PROHIBITED

Contact status - serverDeleteProhibited

STATUS_SERVER_TRANSFER_PROHIBITED

public static final java.lang.String STATUS_SERVER_TRANSFER_PROHIBITED

Contact status - serverTransferProhibited

STATUS_SERVER_UPDATE_PROHIBITED

public static final java.lang.String STATUS_SERVER_UPDATE_PROHIBITED

Contact status - serverUpdateProhibited

Constructor Detail

EppContact

public EppContact()

Creates an EppContact object

EppContact

public EppContact(java.lang.String id)

Creates an EppContact object with a client-supplied contact id

Method Detail

getId

public java.lang.String getId()

Gets the contact id

setId

public void setId(java.lang.String id)

Sets the contact id

getContactDataAscii

public EppContactData getContactDataAscii()

Gets the contact data in ascii encoding

setContactDataAscii

public void setContactDataAscii(EppContactData ascii)

Sets the contact data in ascii encoding

getContactDataI15d

public EppContactData getContactDataI15d()

Gets the contact data in native encoding

setContactDataI15d

public void setContactDataI15d(EppContactData i15d)

Sets the contact data in native encoding

getVoice

public EppE164 getVoice()

Gets the voice phone number of the contact

setVoice

public void setVoice(java.lang.String voice)

Sets the voice phone number of the contact

setVoice

public void setVoice(java.lang.String voice,
                     java.lang.String ext)

Sets the voice phone number and extenstion

setVoice

public void setVoice(EppE164 voice)

Sets the voice phone number of the contact

getFax

public EppE164 getFax()

Gets the fax number of the contact

setFax

public void setFax(java.lang.String fax)

Sets the fax number of the contact

setFax

public void setFax(java.lang.String fax,
                   java.lang.String ext)

Sets the fax number and extenstion

setFax

public void setFax(EppE164 fax)

Sets the fax number extension

getEmail

public java.lang.String getEmail()

Gets the email address of the contact

setEmail

public void setEmail(java.lang.String email)

Sets the email address of the contact

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc,
                                 java.lang.String tag)

Converts the EppContact object into an XML element

Overrides:

toXML in class EppEntity

Parameters:

doc - the XML Document object

tag - the tag/element name for the EppContact object

Returns:

an Element object

fromXML

public static EppEntity fromXML(org.w3c.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

toString

public java.lang.String toString()

Overrides:

toString in class EppEntity

delete

public static EppCommandDeleteContact delete(java.lang.String id,
                                             java.lang.String 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

info

public static EppCommandInfoContact info(java.lang.String id,
                                         java.lang.String 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

check

public static EppCommandCheckContact check(java.lang.String 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

transfer

public static EppCommandTransferContact transfer(java.lang.String id,
                                                 java.lang.String 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

update

public static EppCommandUpdateContact update(java.lang.String id,
                                             java.lang.String 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