public class EPPFeeObjectResult extends java.lang.Object implements EPPCodecComponent
EPPFeeObjectResult
represents a domain result to a check.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_OBJ_ELEMENT
Default value of the "objURI" "element" attribute.
|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPFeeObjectResult . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPFeeObjectResult . |
Constructor and Description |
---|
EPPFeeObjectResult()
Default constructor for
EPPFeeObjectResult . |
EPPFeeObjectResult(java.lang.String aObjID,
java.lang.String aCurrency,
EPPFeeCommand aCommand)
Constructor for
EPPFeeObjectResult that takes the required
object identifier, currency, and command attributes. |
EPPFeeObjectResult(java.lang.String aObjID,
java.lang.String aCurrency,
EPPFeeCommand aCommand,
EPPFeePeriod aPeriod,
EPPFeeValue aFee)
Constructor for
EPPFeeObjectResult that takes all the
primary attributes. |
EPPFeeObjectResult(java.lang.String aObjID,
java.lang.String aCurrency,
EPPFeeCommand aCommand,
EPPFeePeriod aPeriod,
java.util.List<EPPFeeValue> aFees,
java.util.List<EPPFeeCredit> aCredits,
java.lang.String aClassification,
java.lang.String aObjElement)
Constructor for
EPPFeeObjectResult that takes all
attributes. |
Modifier and Type | Method and Description |
---|---|
void |
addCredit(EPPFeeCredit aCredit)
Adds a credit to the list of credits.
|
void |
addFee(EPPFeeValue aFee)
Adds a fee to the list of fees.
|
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
EPPFeeObjectResult with this
instance. |
java.lang.String |
getClassification()
Gets the classification.
|
EPPFeeCommand |
getCommand()
Gets the command value.
|
java.util.List<EPPFeeCredit> |
getCredits()
Gets the list of credits if defined.
|
java.lang.String |
getCurrency()
Gets the currency value.
|
java.util.List<EPPFeeValue> |
getFees()
Gets the list of fees if defined.
|
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.
|
EPPFeePeriod |
getPeriod()
Gets the period value.
|
boolean |
hasClassification()
Is the classification defined?
|
boolean |
hasCredits()
Are the credits defined?
|
boolean |
hasFees()
Are the fees defined?
|
boolean |
hasPeriod()
Is the period defined?
|
void |
setClassification(java.lang.String aClassification)
Sets the classification.
|
void |
setCommand(EPPFeeCommand aCommand)
Sets the command value.
|
void |
setCredits(java.util.List<EPPFeeCredit> aCredits)
Sets the list of credits.
|
void |
setCurrency(java.lang.String aCurrency)
Sets the currency value.
|
void |
setFees(java.util.List<EPPFeeValue> aFees)
Sets the list of fees.
|
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 name value.
|
void |
setPeriod(EPPFeePeriod aPeriod)
Sets the optional 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
EPPFeeObjectResult
.public static final java.lang.String ELM_NAME
EPPFeeObjectResult
.public static final java.lang.String DEFAULT_OBJ_ELEMENT
public EPPFeeObjectResult()
EPPFeeObjectResult
.public EPPFeeObjectResult(java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand)
EPPFeeObjectResult
that takes the required
object identifier, currency, and command attributes.aObjID
- Object identifieraCurrency
- Currency of the feesaCommand
- Command associated with the feespublic EPPFeeObjectResult(java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand, EPPFeePeriod aPeriod, EPPFeeValue aFee)
EPPFeeObjectResult
that takes all the
primary attributes.aObjID
- Object identifieraCurrency
- Currency of the feesaCommand
- Command associated with the feesaPeriod
- Registration period of the fees. Set to null
to
specify no period.aFee
- A single fee valuepublic EPPFeeObjectResult(java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand, EPPFeePeriod aPeriod, java.util.List<EPPFeeValue> aFees, java.util.List<EPPFeeCredit> aCredits, java.lang.String aClassification, java.lang.String aObjElement)
EPPFeeObjectResult
that takes all
attributes.aObjID
- Object identifieraCurrency
- Currency of the feesaCommand
- Command associated with the feesaPeriod
- Registration period of the fees. Set to null
to
specify no period.aFees
- A list of fees that if set to null
indicates no
feesaCredits
- A list of credits that if set to null
indicates
no credits.aClassification
- An optional classification of the domain name. If set to
null
there is no classification.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 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 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 value. Set to null
to specify no period.public boolean hasFees()
true
if the fees are defined; false
otherwise.public java.util.List<EPPFeeValue> getFees()
public void addFee(EPPFeeValue aFee)
aFee
- The fee to add.public void setFees(java.util.List<EPPFeeValue> aFees)
aFees
- The fees to set.public boolean hasCredits()
true
if the credits are defined; false
otherwise.public java.util.List<EPPFeeCredit> getCredits()
public void addCredit(EPPFeeCredit aCredit)
aCredit
- The credit to add.public void setCredits(java.util.List<EPPFeeCredit> aCredits)
aCredits
- The credits to set.public boolean hasClassification()
true
if the classification is defined;
false
otherwise.public java.lang.String getClassification()
null
otherwise.public void setClassification(java.lang.String aClassification)
aClassification
- the classification to setpublic 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 EPPFeeObjectResult
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
instance.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPFeeObjectResult
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)
EPPFeeObjectResult
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
.Copyright © VeriSign Inc. All Rights Reserved.