|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.fee.v07.EPPFeeTransformResult
public abstract class EPPFeeTransformResult
Abstract base class for the transform results (create, renew, update, delete, transfer) for enabling the server to return the currency, fees, credits, balance, and credit limit where appropriate.
Constructor Summary | |
---|---|
EPPFeeTransformResult()
Default constructor for EPPFeeTransformResult . |
|
EPPFeeTransformResult(java.lang.String aCurrency,
java.math.BigDecimal aBalance,
java.math.BigDecimal aCreditLimit,
java.util.List<EPPFeeCredit> aCredits)
Constructor for EPPFeeTransformResult that takes all
attributes that includes credits. |
|
EPPFeeTransformResult(java.lang.String aCurrency,
EPPFeeCredit aCredit)
Constructor for EPPFeeTransformResult that takes the
required currency parameter along with a single credit. |
|
EPPFeeTransformResult(java.lang.String aCurrency,
EPPFeeValue aFee)
Constructor for EPPFeeTransformResult that takes the
required currency parameter along with a single fee. |
|
EPPFeeTransformResult(java.lang.String aCurrency,
java.util.List<EPPFeeValue> aFees,
java.math.BigDecimal aBalance,
java.math.BigDecimal aCreditLimit)
Constructor for EPPFeeTransformResult that takes all
attributes that includes fees. |
Method Summary | |
---|---|
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 EPPFeeTransformResult 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 EPPFeeTransformResult with this
instance. |
java.math.BigDecimal |
getBalance()
Gets the available balance of the client. |
java.math.BigDecimal |
getCreditLimit()
Gets the maximum credit available to the client. |
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. |
protected abstract java.lang.String |
getLocalName()
Abstract method that the sub-class must define to return the local name for the root element. |
EPPFeePeriod |
getPeriod()
Gets the period value. |
boolean |
hasBalance()
Is the balance defined? |
boolean |
hasCreditLimit()
Is the credit limit defined? |
boolean |
hasCredits()
Are the credits defined? |
boolean |
hasCurrency()
Is the currency defined? |
boolean |
hasFees()
Are the fees defined? |
boolean |
hasPeriod()
Is the period defined? |
void |
setBalance(java.math.BigDecimal aBalance)
Sets the available balance of the client. |
void |
setCreditLimit(java.math.BigDecimal aCreditLimit)
Sets the maximum credit available to the client. |
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 |
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 . |
protected abstract void |
validateAttributes()
Validate the set of attributes on encode . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPFeeTransformResult()
EPPFeeTransformResult
.
public EPPFeeTransformResult(java.lang.String aCurrency, EPPFeeValue aFee)
EPPFeeTransformResult
that takes the
required currency parameter along with a single fee.
aCurrency
- Currency of the feeaFee
- A single fee valuepublic EPPFeeTransformResult(java.lang.String aCurrency, EPPFeeCredit aCredit)
EPPFeeTransformResult
that takes the
required currency parameter along with a single credit.
aCurrency
- Currency of the feeaCredit
- A single credit valuepublic EPPFeeTransformResult(java.lang.String aCurrency, java.util.List<EPPFeeValue> aFees, java.math.BigDecimal aBalance, java.math.BigDecimal aCreditLimit)
EPPFeeTransformResult
that takes all
attributes that includes fees.
aCurrency
- The currency of the feesaFees
- The fees of the transform commandaBalance
- The remaining client balanceaCreditLimit
- The maximum credit available to the clientpublic EPPFeeTransformResult(java.lang.String aCurrency, java.math.BigDecimal aBalance, java.math.BigDecimal aCreditLimit, java.util.List<EPPFeeCredit> aCredits)
EPPFeeTransformResult
that takes all
attributes that includes credits.
aCurrency
- The currency of the feesaBalance
- The remaining client balanceaCreditLimit
- The maximum credit available to the clientaCredits
- The credits of the commandMethod Detail |
---|
protected abstract java.lang.String getLocalName()
protected abstract void validateAttributes() throws EPPEncodeException
encode
. Each subclass must
provide their own implementation of validateAttributes
to
validate that the required attributes are set and invalid attribute are
not set prior to the encode
.
EPPEncodeException
- When an attribute is incorrect set or not set.public 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 boolean hasPeriod()
true
if the period is defined; false
otherwise.public EPPFeePeriod getPeriod()
null
otherwise.public void setPeriod(EPPFeePeriod aPeriod)
aPeriod
- Period valuepublic 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 hasBalance()
true
if the balance is defined; false
otherwise.public java.math.BigDecimal getBalance()
null
otherwise.public void setBalance(java.math.BigDecimal aBalance)
aBalance
- The available balance.public boolean hasCreditLimit()
true
if the credit limit is defined;
false
otherwise.public java.math.BigDecimal getCreditLimit()
balance
attribute can go to.
null
otherwise.public void setCreditLimit(java.math.BigDecimal aCreditLimit)
balance
attribute can go to.
aCreditLimit
- The maximum credit available to the client.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- DOM Document, which acts is an Element factory
EPPEncodeException
- Error encoding EPPFeeTransformResult
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 decode
EPPDecodeException
- Error decoding Element
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPFeeTransformResult
instance.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPFeeTransformResult
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)
EPPFeeTransformResult
with this
instance.
equals
in class java.lang.Object
aObject
- Object to compare with.
true
if equal; false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |