public class EPPFeeObject extends java.lang.Object implements EPPCodecComponent
EPPFeeObject
represents an object to check for the fee using the
EPPFeeCheck
extension.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 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. |
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 . |
public static final java.lang.String ELM_LOCALNAME
EPPFeeObject
.public static final java.lang.String ELM_NAME
EPPFeeObject
.public static final java.lang.String DEFAULT_OBJ_URI
public static final java.lang.String DEFAULT_OBJ_ELEMENT
public EPPFeeObject()
EPPFeeObject
.public EPPFeeObject(java.lang.String aObjID, EPPFeeCommand aCommand)
EPPFeeObject
that takes the required object
identifier and command parameters.aObjID
- Object identifier to checkaCommand
- Command to checkpublic EPPFeeObject(java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand, EPPFeePeriod aPeriod)
EPPFeeObject
that takes the most likely
attributes.aObjID
- Object identifier to checkaCurrency
- desired currency to returnaCommand
- Command to checkaPeriod
- Registration period to checkpublic EPPFeeObject(java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand, EPPFeePeriod aPeriod, java.lang.String aObjURI, java.lang.String aObjElement)
EPPFeeObject
that takes all attributes.aObjID
- Object identifier to checkaCurrency
- desired currency to returnaCommand
- Command to checkaPeriod
- Registration period to checkaObjURI
- 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
.public java.lang.String getObjID()
null
otherwise.public void setObjID(java.lang.String aObjID)
aObjID
- Object identifier valuepublic boolean hasCurrency()
true
if the currency is defined; false
otherwise.public java.lang.String getCurrency()
null
otherwise.public void setCurrency(java.lang.String aCurrency)
aCurrency
- Currency valuepublic EPPFeeCommand getCommand()
null
otherwise.public void setCommand(EPPFeeCommand aCommand)
aCommand
- Command valuepublic boolean hasPeriod()
true
if the period is defined; false
otherwise.public EPPFeePeriod getPeriod()
null
otherwise.public void setPeriod(EPPFeePeriod aPeriod)
aPeriod
- Period valuepublic java.lang.String getObjURI()
DEFAULT_OBJ_URI
.public void setObjURI(java.lang.String aObjURI)
aObjURI
- Object URI of the type of object.public java.lang.String getObjElement()
DEFAULT_OBJ_ELEMENT
.public void setObjElement(java.lang.String aObjElement)
aObjElement
- Local name of the object attribute that uniquely identifies
the objectpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- DOM Document, which acts is an Element factoryEPPEncodeException
- Error encoding EPPFeeObject
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
aElement
argument represents the root DOM element and is
used to traverse the DOM nodes for instance attribute values.decode
in interface EPPCodecComponent
aElement
- Element
to decodeEPPDecodeException
- Error decoding Element
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCodecComponent
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPFeeObject
.java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.public boolean equals(java.lang.Object aObject)
EPPFeeObject
with this instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if equal; false
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.