com.verisign.epp.codec.fee.v06
Class EPPFeeInfo

java.lang.Object
  com.verisign.epp.codec.fee.v06.EPPFeeInfo

All Implemented Interfaces:

EPPCodecComponent, java.io.Serializable, java.lang.Cloneable

public class EPPFeeInfo
extends java.lang.Object
implements EPPCodecComponent

Fee Info Extension that enables a client to pass fee query information to get fee information for the domain name back from the server.

See Also:

Serialized Form

Field Summary

static java.lang.String	ELM_LOCALNAME XML local name for EPPFeeInfo.
static java.lang.String	ELM_NAME XML root tag for EPPFeeInfo.

Constructor Summary

EPPFeeInfo()
Default constructor for EPPFeeInfo.

EPPFeeInfo(EPPFeeCommand aCommand)
Constructor for EPPFeeInfo that takes the required command parameter.

EPPFeeInfo(java.lang.String aCurrency, EPPFeeCommand aCommand, EPPFeePeriod aPeriod)
Constructor for EPPFeeInfo that takes all attributes.

Method Summary

java.lang.Object	clone() Clone an EPPCodecComponent instance.
void	decode(org.w3c.dom.Element aElement) Decode a DOM element tree to initialize the instance attributes.
org.w3c.dom.Element	encode(org.w3c.dom.Document aDocument) Encode instance into a DOM element tree.
boolean	equals(java.lang.Object aObject) Compare an instance of EPPFeeInfo with this instance.
EPPFeeCommand	getCommand() Gets the command value.
java.lang.String	getCurrency() Gets the currency value.
EPPFeePeriod	getPeriod() Gets the period value.
boolean	hasCurrency() Is the currency defined?
boolean	hasPeriod() Is the period defined?
void	setCommand(EPPFeeCommand aCommand) Sets the command value.
void	setCurrency(java.lang.String aCurrency) Sets the currency value.
void	setPeriod(EPPFeePeriod aPeriod) Sets the period value.
java.lang.String	toString() Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ELM_LOCALNAME

public static final java.lang.String ELM_LOCALNAME

XML local name for EPPFeeInfo.

See Also:

Constant Field Values

ELM_NAME

public static final java.lang.String ELM_NAME

XML root tag for EPPFeeInfo.

See Also:

Constant Field Values

Constructor Detail

EPPFeeInfo

public EPPFeeInfo()

Default constructor for EPPFeeInfo.

EPPFeeInfo

public EPPFeeInfo(EPPFeeCommand aCommand)

Constructor for EPPFeeInfo that takes the required command parameter.

Parameters:

aCommand - Command to check

EPPFeeInfo

public EPPFeeInfo(java.lang.String aCurrency,
                  EPPFeeCommand aCommand,
                  EPPFeePeriod aPeriod)

Constructor for EPPFeeInfo that takes all attributes.

Parameters:

aCurrency - desired currency to return

aCommand - Command to check

aPeriod - Registration period to check

Method Detail

hasCurrency

public boolean hasCurrency()

Is the currency defined?

Returns:

true if the currency is defined; false otherwise.

getCurrency

public java.lang.String getCurrency()

Gets the currency value.

Returns:

Currency if defined; null otherwise.

setCurrency

public void setCurrency(java.lang.String aCurrency)

Sets the currency value.

Parameters:

aCurrency - Currency value

getCommand

public EPPFeeCommand getCommand()

Gets the command value.

Returns:

Command value if defined; null otherwise.

setCommand

public void setCommand(EPPFeeCommand aCommand)

Sets the command value.

Parameters:

aCommand - Command value

hasPeriod

public boolean hasPeriod()

Is the period defined?

Returns:

true if the period is defined; false otherwise.

getPeriod

public EPPFeePeriod getPeriod()

Gets the period value.

Returns:

Period if defined; null otherwise.

setPeriod

public void setPeriod(EPPFeePeriod aPeriod)

Sets the period value.

Parameters:

aPeriod - Period value

encode

public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument)
                           throws EPPEncodeException

Encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.

Specified by:

encode in interface EPPCodecComponent

Parameters:

aDocument - DOM Document, which acts is an Element factory

Returns:

Element Root element associated with the object

Throws:

EPPEncodeException - Error encoding EPPFeeInfo

decode

public void decode(org.w3c.dom.Element aElement)
            throws EPPDecodeException

Decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - Element to decode

Throws:

EPPDecodeException - Error decoding Element

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone an EPPCodecComponent instance.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class java.lang.Object

Returns:

clone of concrete EPPFeeInfo

Throws:

java.lang.CloneNotSupportedException - standard Object.clone exception

toString

public java.lang.String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class java.lang.Object

Returns:

Indented XML String if successful; ERROR otherwise.

equals

public boolean equals(java.lang.Object aObject)

Compare an instance of EPPFeeInfo with this instance.

Overrides:

equals in class java.lang.Object

Parameters:

aObject - Object to compare with.

Returns:

true if equal; false otherwise.