com.verisign.epp.codec.fee.v11

Class EPPFeeCheck

java.lang.Object

com.verisign.epp.codec.fee.v11.EPPFeeCheck

All Implemented Interfaces:

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

public class EPPFeeCheck
extends java.lang.Object
implements EPPCodecComponent

Fee Check Extension that enables a client to pass a command along with optionally the currency, period, and fee class to apply to the objects in the check command.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELM_LOCALNAME XML local name for EPPFeeCheck.
static java.lang.String	ELM_NAME XML root tag for EPPFeeCheck.

Constructor Summary

Constructors

Constructor and Description
EPPFeeCheck() Default constructor for EPPFeeCheck.
EPPFeeCheck(EPPFeeCommand aCommand) Constructor for EPPFeeCheck that takes the required command attribute.
EPPFeeCheck(EPPFeeCommand aCommand, java.lang.String aCurrency, EPPFeePeriod aPeriod, java.lang.String aClassification) Constructor for EPPFeeCheck that takes the required command attribute and all of the optional attributes..

Method Summary

Modifier and Type	Method and Description
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 EPPFeeCheck with this instance.
java.lang.String	getClassification() Gets the fee classification value.
EPPFeeCommand	getCommand() Gets the command value.
java.lang.String	getCurrency() Gets the currency value.
java.lang.String	getNamespace() Returns the XML namespace associated with the EPPCodecComponent.
EPPFeePeriod	getPeriod() Gets the period value.
boolean	hasClassification() Is the fee classification defined?
boolean	hasCurrency() Is the currency defined?
boolean	hasPeriod() Is the period defined?
void	setClassification(java.lang.String aClassification) Sets the fee classification value.
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 EPPFeeCheck.

See Also:

Constant Field Values

ELM_NAME

public static final java.lang.String ELM_NAME

XML root tag for EPPFeeCheck.

See Also:

Constant Field Values

Constructor Detail

EPPFeeCheck

public EPPFeeCheck()

Default constructor for EPPFeeCheck.

EPPFeeCheck

public EPPFeeCheck(EPPFeeCommand aCommand)

Constructor for EPPFeeCheck that takes the required command attribute.

Parameters:

aCommand - Command to check

EPPFeeCheck

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

Constructor for EPPFeeCheck that takes the required command attribute and all of the optional attributes..

Parameters:

aCommand - Command to check

aCurrency - OPTIONAL desired currency to return

aPeriod - OPTIONAL Registration period to check

aClassification - OPTIONAL classification value

Method Detail

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

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

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

hasClassification

public boolean hasClassification()

Is the fee classification defined?

Returns:

true if the fee classification is defined; false otherwise.

getClassification

public java.lang.String getClassification()

Gets the fee classification value.

Returns:

Fee classification if defined; null otherwise.

setClassification

public void setClassification(java.lang.String aClassification)

Sets the fee classification value.

Parameters:

aClassification - fee classification 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 EPPFeeCheck

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 EPPFeeCheck

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 EPPFeeCheck with this instance.

Overrides:

equals in class java.lang.Object

Parameters:

aObject - Object to compare with.

Returns:

true if equal; false otherwise.

getNamespace

public java.lang.String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.