com.verisign.epp.codec.fee.v09

Class EPPFeeObject

java.lang.Object

com.verisign.epp.codec.fee.v09.EPPFeeObject

All Implemented Interfaces:

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

public class EPPFeeObject
extends java.lang.Object
implements EPPCodecComponent

EPPFeeObject represents an object to check for the fee using the EPPFeeCheck extension.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_OBJ_ELEMENT Default value of the "objURI" "element" attribute.
static java.lang.String	DEFAULT_OBJ_URI Default value of the "objURI" attribute of the object element.
static java.lang.String	ELM_LOCALNAME XML local name for EPPFeeObject.
static java.lang.String	ELM_NAME XML root tag for EPPFeeObject.

Constructor Summary

Constructors

Constructor and Description
EPPFeeObject() Default constructor for EPPFeeObject.
EPPFeeObject(java.lang.String aObjID, EPPFeeCommand aCommand) Constructor for EPPFeeObject that takes the required object identifier and command parameters.
EPPFeeObject(java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand, EPPFeePeriod aPeriod) Constructor for EPPFeeObject that takes the most likely attributes.
EPPFeeObject(java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand, EPPFeePeriod aPeriod, java.lang.String aObjURI, java.lang.String aObjElement) Constructor for EPPFeeObject that takes all attributes.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() clone an EPPCodecComponent.
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 EPPFeeObject with this instance.
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.
java.lang.String	getObjElement() Gets the local name of the object attribute that uniquely identifies the object.
java.lang.String	getObjID() Gets the object identifier value.
java.lang.String	getObjURI() Gets the "objURI" attribute that identifies the type of the object.
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	setObjElement(java.lang.String aObjElement) Sets the local name of the object attribute that uniquely identifies the object.
void	setObjID(java.lang.String aObjID) Sets the object identifier value.
void	setObjURI(java.lang.String aObjURI) Sets the "objURI" attribute that identifies the type of the object.
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 EPPFeeObject.

See Also:

Constant Field Values

ELM_NAME

public static final java.lang.String ELM_NAME

XML root tag for EPPFeeObject.

See Also:

Constant Field Values

DEFAULT_OBJ_URI

public static final java.lang.String DEFAULT_OBJ_URI

Default value of the "objURI" attribute of the object element.

See Also:

Constant Field Values

DEFAULT_OBJ_ELEMENT

public static final java.lang.String DEFAULT_OBJ_ELEMENT

Default value of the "objURI" "element" attribute.

See Also:

Constant Field Values

Constructor Detail

EPPFeeObject

public EPPFeeObject()

Default constructor for EPPFeeObject.

EPPFeeObject

public EPPFeeObject(java.lang.String aObjID,
                    EPPFeeCommand aCommand)

Constructor for EPPFeeObject that takes the required object identifier and command parameters.

Parameters:

aObjID - Object identifier to check

aCommand - Command to check

EPPFeeObject

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

Constructor for EPPFeeObject that takes the most likely attributes.

Parameters:

aObjID - Object identifier to check

aCurrency - desired currency to return

aCommand - Command to check

aPeriod - Registration period to check

EPPFeeObject

public EPPFeeObject(java.lang.String aObjID,
                    java.lang.String aCurrency,
                    EPPFeeCommand aCommand,
                    EPPFeePeriod aPeriod,
                    java.lang.String aObjURI,
                    java.lang.String aObjElement)

Constructor for EPPFeeObject that takes all attributes.

Parameters:

aObjID - Object identifier to check

aCurrency - desired currency to return

aCommand - Command to check

aPeriod - Registration period to check

aObjURI - Type of object with the default value of DEFAULT_OBJ_URI.

aObjElement - Local name of the object attribute with the default value of DEFAULT_OBJ_ELEMENT.

Method Detail

getObjID

public java.lang.String getObjID()

Gets the object identifier value.

Returns:

Object identifier value if defined; null otherwise.

setObjID

public void setObjID(java.lang.String aObjID)

Sets the object identifier value.

Parameters:

aObjID - Object identifier 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

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

getObjURI

public java.lang.String getObjURI()

Gets the "objURI" attribute that identifies the type of the object.

Returns:

Type of object with the default value of DEFAULT_OBJ_URI .

setObjURI

public void setObjURI(java.lang.String aObjURI)

Sets the "objURI" attribute that identifies the type of the object.

Parameters:

aObjURI - Object URI of the type of object.

getObjElement

public java.lang.String getObjElement()

Gets the local name of the object attribute that uniquely identifies the object.

Returns:

Local name of the object attribute that uniquely identifies the object with the default value of DEFAULT_OBJ_ELEMENT.

setObjElement

public void setObjElement(java.lang.String aObjElement)

Sets the local name of the object attribute that uniquely identifies the object.

Parameters:

aObjElement - Local name of the object attribute that uniquely identifies the object

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 EPPFeeObject

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.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class java.lang.Object

Returns:

clone of concrete EPPFeeObject.

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 EPPFeeObject 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.