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 |
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 aObjXMLNs,
java.lang.String aObjectXMLName,
java.lang.String aObjID,
java.lang.String aCurrency,
EPPFeeCommand aCommand)
Constructor for
EPPFeeObjectResult that takes the required
attributes for an available fee. |
EPPFeeObjectResult(java.lang.String aObjXMLNs,
java.lang.String aObjectXMLName,
java.lang.String aObjID,
java.lang.String aCurrency,
EPPFeeCommand aCommand,
EPPFeePeriod aPeriod,
EPPFeeValue aFee)
Constructor for
EPPFeeObjectResult that takes all the
required attributes and a single fee for an available fee. |
EPPFeeObjectResult(java.lang.String aObjXMLNs,
java.lang.String aObjectXMLName,
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)
Constructor for
EPPFeeObjectResult that takes all attributes
for an available fee. |
EPPFeeObjectResult(java.lang.String aObjXMLNs,
java.lang.String aObjectXMLName,
java.lang.String aObjID,
java.lang.String aCurrency,
EPPFeeCommand aCommand,
java.lang.String aReason)
Constructor for
EPPFeeObjectResult that takes the attributes
for an unavailable fee. |
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 |
getObjID()
Gets the object identifier value.
|
java.lang.String |
getObjXmlName()
Gets object XML element name including the prefix and the local name as
in "domain:name", which has the prefix of "domain"
and the local name "name".
|
java.lang.String |
getObjXmlNs()
Gets the object XML namespace.
|
EPPFeePeriod |
getPeriod()
Gets the period value.
|
java.lang.String |
getReason()
Gets the reason 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?
|
boolean |
hasReason()
Is the reason defined if the available attribute is
false ? |
boolean |
isAvailable()
Is the fee information available?
|
void |
setAvailable(boolean aAvailable)
Sets the fee information available value.
|
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 |
setObjID(java.lang.String aObjID)
Sets the name value.
|
void |
setObjXmlName(java.lang.String aObjXmlName)
Sets object XML element name including the prefix and the local name as
in "domain:name", which has the prefix of "domain"
and the local name "name".
|
void |
setObjXmlNs(java.lang.String aObjXmlNs)
Sets the object XML namespace.
|
void |
setPeriod(EPPFeePeriod aPeriod)
Sets the optional period value.
|
void |
setReason(java.lang.String aReason)
Sets the reason 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 EPPFeeObjectResult()
EPPFeeObjectResult
.public EPPFeeObjectResult(java.lang.String aObjXMLNs, java.lang.String aObjectXMLName, java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand)
EPPFeeObjectResult
that takes the required
attributes for an available fee.aObjXMLNs
- Object XML Namespace. An example is
com.verisign.epp.codec.domain.EPPDomainMapFactory.NS
with the value "urn:ietf:params:xml:ns:domain-1.0"
to reference the domain name element.aObjectXMLName
- Object XML element name including the prefix and the local
name as in "domain:name", which has the prefix of
"domain" and the local name "name"aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aCurrency
- Currency of the feesaCommand
- Command associated with the feespublic EPPFeeObjectResult(java.lang.String aObjXMLNs, java.lang.String aObjectXMLName, java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand, java.lang.String aReason)
EPPFeeObjectResult
that takes the attributes
for an unavailable fee.aObjXMLNs
- Object XML Namespace. An example is
com.verisign.epp.codec.domain.EPPDomainMapFactory.NS
with the value "urn:ietf:params:xml:ns:domain-1.0"
to reference the domain name element.aObjectXMLName
- Object XML element name including the prefix and the local
name as in "domain:name", which has the prefix of
"domain" and the local name "name"aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aCurrency
- Currency of the feesaCommand
- Command associated with the feesaReason
- Reason that the fee is unavailablepublic EPPFeeObjectResult(java.lang.String aObjXMLNs, java.lang.String aObjectXMLName, java.lang.String aObjID, java.lang.String aCurrency, EPPFeeCommand aCommand, EPPFeePeriod aPeriod, EPPFeeValue aFee)
EPPFeeObjectResult
that takes all the
required attributes and a single fee for an available fee.aObjXMLNs
- Object XML Namespace. An example is
com.verisign.epp.codec.domain.EPPDomainMapFactory.NS
with the value "urn:ietf:params:xml:ns:domain-1.0"
to reference the domain name element.aObjectXMLName
- Object XML element name including the prefix and the local
name as in "domain:name", which has the prefix of
"domain" and the local name "name"aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aCurrency
- Currency of the feesaCommand
- Command associated with the feesaFee
- A single fee valuepublic EPPFeeObjectResult(java.lang.String aObjXMLNs, java.lang.String aObjectXMLName, 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)
EPPFeeObjectResult
that takes all attributes
for an available fee.aObjXMLNs
- Object XML Namespace. An example is
com.verisign.epp.codec.domain.EPPDomainMapFactory.NS
with the value "urn:ietf:params:xml:ns:domain-1.0"
to reference the domain name element.aObjectXMLName
- Object XML element name including the prefix and the local
name as in "domain:name", which has the prefix of
"domain" and the local name "name"aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aCurrency
- Currency of the feesaCommand
- Command associated with the feesaFees
- 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.public java.lang.String getObjXmlNs()
com.verisign.epp.codec.domain.EPPDomainMapFactory.NS
with
the value "urn:ietf:params:xml:ns:domain-1.0" to reference the
domain name element.public void setObjXmlNs(java.lang.String aObjXmlNs)
com.verisign.epp.codec.domain.EPPDomainMapFactory.NS
with
the value "urn:ietf:params:xml:ns:domain-1.0" to reference the
domain name element.aObjXmlNs
- object XML namespacepublic java.lang.String getObjXmlName()
public void setObjXmlName(java.lang.String aObjXmlName)
aObjXmlName
- object XML element namepublic java.lang.String getObjID()
null
otherwise.public void setObjID(java.lang.String aObjID)
aObjID
- Object identifier valuepublic boolean isAvailable()
getReason()
to get the
optional reason when available is false
.true
if the fee information is available;
false
otherwise.public void setAvailable(boolean aAvailable)
setReason(String)
to set the optional reason when available is false
.aAvailable
- true
if the fee is available; 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 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 boolean hasReason()
false
?true
if the reason is defined; false
otherwise.public java.lang.String getReason()
null
otherwise.public void setReason(java.lang.String aReason)
aReason
- reason valuepublic 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.