com.verisign.epp.codec.fee.v09

Class EPPFeeCheck

java.lang.Object

com.verisign.epp.codec.fee.v09.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 list of domain names and fee query information to get fee information back from the server.

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(java.util.List<EPPFeeObject> aObjects) Constructor for EPPFeeCheck that takes the list of domains to check.

Method Summary

Modifier and Type	Method and Description
void	addObject(EPPFeeObject aObject) Adds an object to the list of objects to check the fee.
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	getNamespace() Returns the XML namespace associated with the EPPCodecComponent.
java.util.List<EPPFeeObject>	getObjects() Gets the list of objects to check.
void	setObjects(java.util.List<EPPFeeObject> aObjects) Sets the list of objects to check.
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(java.util.List<EPPFeeObject> aObjects)

Constructor for EPPFeeCheck that takes the list of domains to check.

Parameters:

aObjects - A list of EPPFeeObject objects to check.

Method Detail

addObject

public void addObject(EPPFeeObject aObject)

Adds an object to the list of objects to check the fee.

Parameters:

aObject - Object to add.

getObjects

public java.util.List<EPPFeeObject> getObjects()

Gets the list of objects to check.

Returns:

List of EPPFeeObject instances. The list should never be null.

setObjects

public void setObjects(java.util.List<EPPFeeObject> aObjects)

Sets the list of objects to check.

Parameters:

aObjects - List of EPPFeeObject instances to check.

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.