com.neulevel.epp.xri
Class EppXriNumber

java.lang.Object
  com.neulevel.epp.core.EppEntity
      com.neulevel.epp.core.EppObject
          com.neulevel.epp.xri.EppXriNumber

public class EppXriNumber
extends EppObject

This EppXriNumber class implements EPP XRI I-Number objects.

Version:

$Revision: 1.4 $ $Date: 2008/03/21 00:32:29 $

Author:

Ning Zhang ning.zhang@neustar.com

Field Summary

static int	DEFAULT_PRIORITY Deprecated.
static java.lang.String	STATUS_CLIENT_DELETE_PROHIBITED I-Number status - clientDeleteProhibited
static java.lang.String	STATUS_CLIENT_HOLD I-Number status - clientHold
static java.lang.String	STATUS_CLIENT_RENEW_PROHIBITED I-Number status - clientRenewProhibited
static java.lang.String	STATUS_CLIENT_UPDATE_PROHIBITED I-Number status - clientUpdateProhibited
static java.lang.String	STATUS_OK I-Number status - ok
static java.lang.String	STATUS_PENDING_CREATE I-Number status - pendingCreate
static java.lang.String	STATUS_PENDING_DELETE I-Number status - pendingDelete
static java.lang.String	STATUS_PENDING_TRANSFER I-Number status - pendingTransfer
static java.lang.String	STATUS_PENDING_UPDATE I-Number status - pendingUpdate
static java.lang.String	STATUS_SERVER_DELETE_PROHIBITED I-Number status - serverDeleteProhibited
static java.lang.String	STATUS_SERVER_HOLD I-Number status - serverHold
static java.lang.String	STATUS_SERVER_RENEW_PROHIBITED I-Number status - serverRenewProhibited
static java.lang.String	STATUS_SERVER_UPDATE_PROHIBITED I-Number status - serverUpdateProhibited
static java.lang.String	STATUS_TERMINATED I-Number status - terminated

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

authInfo, clID, CONTACT, crDate, crID, DOMAIN, exDate, HOST, roid, status, SVCSUB, trDate, upDate, upID, XRI_AUTHORITY, XRI_INAME, XRI_INUMBER, XRI_ISERVICE

Constructor Summary

EppXriNumber()
Creates an EppXriNumber object

EppXriNumber(java.lang.String inumber)
Creates an EppXriNumber object with an XRI i-number

Method Summary

static EppCommandCheckXriNumber	check(java.lang.String xid) Creates an EppCommandCheckXriNumber object for checking the existance of EPP XRI I-Number objects in the registry.
static EppCommandDeleteXriNumber	delete(java.lang.String inumber, java.lang.String xid) Creates an EppCommandDeleteXriNumber object for deleting an EPP XRI I-Number object from the registry.
static EppEntity	fromXML(org.w3c.dom.Node root) Converts an XML element into an EppXriNumber object.
java.lang.String	getAuthorityId() Gets the identifier of the superordinate XRI authority object
java.lang.String	getINumber() Gets the i-number
EppPeriod	getPeriod() Gets registration period for the i-number
int	getPriority() Deprecated.
java.lang.String	getReferenceId() Gets the reference identifier used in generating the i-number, if any
static EppCommandInfoXriNumber	info(java.lang.String inumber, java.lang.String xid) Creates an EppCommandInfoXriNumber object for querying the details of an EPP XRI I-Number object
static EppCommandRenewXriNumber	renew(java.lang.String inumber, java.util.Calendar curExpDate, EppPeriod period, java.lang.String xid) Creates an EppCommandRenewXriNumber object for renewing the registration of an EPP XRI I-Number object in the registry.
void	setAuthority(java.lang.String authId, EppAuthInfo authInfo) Sets the identifier of the superorindate XRI authority object, and authInfo associated with the authority, if any
void	setAuthorityId(java.lang.String authId) Sets the identifier of the superordinate XRI authority object
void	setINumber(java.lang.String inumber) Sets the i-number
void	setPeriod(EppPeriod period) Sets registration period for the i-number
void	setPriority(int priority) Deprecated.
void	setReferenceId(java.lang.String refId) Gets the reference identifier used in generating the i-number, if any
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc, java.lang.String tag) Converts the EppXriNumber object into an XML element
static EppCommandUpdateXriNumber	update(java.lang.String inumber, java.lang.String xid) Creates an EppCommandUpdateXriNumber object for updating an EPP I-Number 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

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

Deprecated.

Default priority value - 10

See Also:

Constant Field Values

STATUS_CLIENT_DELETE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_DELETE_PROHIBITED

I-Number status - clientDeleteProhibited

See Also:

Constant Field Values

STATUS_CLIENT_HOLD

public static final java.lang.String STATUS_CLIENT_HOLD

I-Number status - clientHold

See Also:

Constant Field Values

STATUS_CLIENT_RENEW_PROHIBITED

public static final java.lang.String STATUS_CLIENT_RENEW_PROHIBITED

I-Number status - clientRenewProhibited

See Also:

Constant Field Values

STATUS_CLIENT_UPDATE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_UPDATE_PROHIBITED

I-Number status - clientUpdateProhibited

See Also:

Constant Field Values

STATUS_OK

public static final java.lang.String STATUS_OK

I-Number status - ok

See Also:

Constant Field Values

STATUS_PENDING_CREATE

public static final java.lang.String STATUS_PENDING_CREATE

I-Number status - pendingCreate

See Also:

Constant Field Values

STATUS_PENDING_DELETE

public static final java.lang.String STATUS_PENDING_DELETE

I-Number status - pendingDelete

See Also:

Constant Field Values

STATUS_PENDING_TRANSFER

public static final java.lang.String STATUS_PENDING_TRANSFER

I-Number status - pendingTransfer

See Also:

Constant Field Values

STATUS_PENDING_UPDATE

public static final java.lang.String STATUS_PENDING_UPDATE

I-Number status - pendingUpdate

See Also:

Constant Field Values

STATUS_SERVER_DELETE_PROHIBITED

public static final java.lang.String STATUS_SERVER_DELETE_PROHIBITED

I-Number status - serverDeleteProhibited

See Also:

Constant Field Values

STATUS_SERVER_HOLD

public static final java.lang.String STATUS_SERVER_HOLD

I-Number status - serverHold

See Also:

Constant Field Values

STATUS_SERVER_RENEW_PROHIBITED

public static final java.lang.String STATUS_SERVER_RENEW_PROHIBITED

I-Number status - serverRenewProhibited

See Also:

Constant Field Values

STATUS_SERVER_UPDATE_PROHIBITED

public static final java.lang.String STATUS_SERVER_UPDATE_PROHIBITED

I-Number status - serverUpdateProhibited

See Also:

Constant Field Values

STATUS_TERMINATED

public static final java.lang.String STATUS_TERMINATED

I-Number status - terminated

See Also:

Constant Field Values

Constructor Detail

EppXriNumber

public EppXriNumber()

Creates an EppXriNumber object

EppXriNumber

public EppXriNumber(java.lang.String inumber)

Creates an EppXriNumber object with an XRI i-number

Method Detail

getINumber

public java.lang.String getINumber()

Gets the i-number

setINumber

public void setINumber(java.lang.String inumber)

Sets the i-number

setAuthority

public void setAuthority(java.lang.String authId,
                         EppAuthInfo authInfo)

Sets the identifier of the superorindate XRI authority object, and authInfo associated with the authority, if any

getAuthorityId

public java.lang.String getAuthorityId()

Gets the identifier of the superordinate XRI authority object

setAuthorityId

public void setAuthorityId(java.lang.String authId)

Sets the identifier of the superordinate XRI authority object

getReferenceId

public java.lang.String getReferenceId()

Gets the reference identifier used in generating the i-number, if any

setReferenceId

public void setReferenceId(java.lang.String refId)

Gets the reference identifier used in generating the i-number, if any

getPriority

public int getPriority()

Deprecated.

Gets the priority value for this XRI i-number

setPriority

public void setPriority(int priority)

Deprecated.

Sets the priority value for this XRI i-number

getPeriod

public EppPeriod getPeriod()

Gets registration period for the i-number

setPeriod

public void setPeriod(EppPeriod period)

Sets registration period for the i-number

toXML

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

Converts the EppXriNumber object into an XML element

Specified by:

toXML in class EppEntity

Parameters:

doc - the XML Document object

tag - the tag/element name for the EppXriNumber object

Returns:

an Element object

fromXML

public static EppEntity fromXML(org.w3c.dom.Node root)

Converts an XML element into an EppXriNumber object. The caller of this method must make sure that the root node is of the EPP I-Number type.

Parameters:

root - root node for an EppXriNumber object in XML format

Returns:

an EppXriNumber object, or null if the node is invalid

toString

public java.lang.String toString()

Specified by:

toString in class EppEntity

delete

public static EppCommandDeleteXriNumber delete(java.lang.String inumber,
                                               java.lang.String xid)

Creates an EppCommandDeleteXriNumber object for deleting an EPP XRI I-Number object from the registry.

Parameters:

inumber - the i-number of the XRI i-number object to be deleted

xid - the client transaction id associated with the operation

info

public static EppCommandInfoXriNumber info(java.lang.String inumber,
                                           java.lang.String xid)

Creates an EppCommandInfoXriNumber object for querying the details of an EPP XRI I-Number object

Parameters:

inumber - the i-number of the XRI i-number object to be queried

xid - the client transaction id associated with the operation

check

public static EppCommandCheckXriNumber check(java.lang.String xid)

Creates an EppCommandCheckXriNumber object for checking the existance of EPP XRI I-Number objects in the registry. Identifiers of EPP XRI I-Number objects can be added via the add or addINumber methods.

Parameters:

xid - the client transaction id associated with the operation

renew

public static EppCommandRenewXriNumber renew(java.lang.String inumber,
                                             java.util.Calendar curExpDate,
                                             EppPeriod period,
                                             java.lang.String xid)

Creates an EppCommandRenewXriNumber object for renewing the registration of an EPP XRI I-Number object in the registry.

Parameters:

inumber - the inumber of the XRI i-number object to be renewed

curExpDate - the current expiration date of the svcsub object

period - the new registration period of the svcsub object, or null if using the value specified by the registry

xid - the client transaction id associated with the operation

update

public static EppCommandUpdateXriNumber update(java.lang.String inumber,
                                               java.lang.String xid)

Creates an EppCommandUpdateXriNumber object for updating an EPP I-Number object in the registry. The actual update information should be specified via the various methods defined for the EppCommandUpdateXriNumber object.

Parameters:

inumber - the i-number of the XRI i-number object to be updated

xid - the client transaction id associated with the operation