public class EPPFeeCommandData extends EPPFeeCommand
EPPFeeCommand
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_STANDARD
OPTIONAL standard attribute name that specifies the standard command fee
with a default value of "0".
|
ATTR_CUSTOMNAME, ATTR_NAME, ATTR_PHASE, ATTR_SUBPHASE, ELM_LOCALNAME, ELM_NAME
Constructor and Description |
---|
EPPFeeCommandData()
Default constructor.
|
EPPFeeCommandData(Command aCommand)
Create
EPPFeeCommand instance with a defined command value. |
EPPFeeCommandData(Command aCommand,
Phase aPhase)
Create
EPPFeeCommand instance with a defined command and
phase value. |
EPPFeeCommandData(Command aCommand,
Phase aPhase,
java.lang.String aSubPhase)
Create
EPPFeeCommand instance with a defined command, phase,
and sub-phase value. |
EPPFeeCommandData(Command aCommand,
java.lang.String aCustomName)
Create
EPPFeeCommand instance with a defined command value
and custom name value. |
EPPFeeCommandData(Command aCommand,
java.lang.String aCustomName,
Phase aPhase,
java.lang.String aSubPhase,
boolean aStandard,
EPPFeePeriod aPeriod,
java.util.List<EPPFeeValue> aFees,
java.util.List<EPPFeeCredit> aCredits,
java.lang.String aReason,
java.lang.String aLanguage)
Create
EPPFeeCommand instance with all attributes. |
EPPFeeCommandData(EPPFeeCommand aCommand)
Instantiate instance by using an existing
EPPFeeCommand
instance. |
EPPFeeCommandData(EPPFeeCommandData aCommand)
Instantiate instance by using an existing
EPPFeeCommandData
instance. |
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
EPPFeeCommand instance. |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPFeeCommand element aElement DOM Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the
EPPFeeCommand instance. |
boolean |
equals(java.lang.Object aObject)
Implements a deep
EPPFeeCommand compare. |
java.util.List<EPPFeeCredit> |
getCredits()
Gets the list of credits if defined.
|
java.util.List<EPPFeeValue> |
getFees()
Gets the list of fees if defined.
|
java.lang.String |
getLanguage()
Gets reason language
|
java.lang.String |
getReason()
Gets the reason value.
|
boolean |
hasCredits()
Are the credits defined?
|
boolean |
hasFees()
Are the fees defined?
|
boolean |
hasReason()
Is the reason defined if the available attribute is
false ? |
boolean |
isStandard()
Is the command a standard command?
|
void |
setCredits(java.util.List<EPPFeeCredit> aCredits)
Sets the list of credits.
|
void |
setFees(java.util.List<EPPFeeValue> aFees)
Sets the list of fees.
|
void |
setLanguage(java.lang.String aLanguage)
Sets language attribute.
|
void |
setReason(java.lang.String aReason)
Sets the reason value.
|
void |
setStandard(boolean aStandard)
Sets whether the command is a standard fee command.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
getCommand, getCustomName, getNamespace, getPeriod, getPhase, getSubPhase, hasCommand, hasCustomName, hasPeriod, hasPhase, hasSubPhase, setCommand, setCustomName, setPeriod, setPhase, setSubPhase
public static final java.lang.String ATTR_STANDARD
public EPPFeeCommandData()
public EPPFeeCommandData(EPPFeeCommand aCommand)
EPPFeeCommand
instance. This will clone the EPPFeeCommand
attributes.aCommand
- instance to initialize the EPPFeeCommand
instance
with.public EPPFeeCommandData(EPPFeeCommandData aCommand)
EPPFeeCommandData
instance. This is equivalent to cloning the EPPFeeCommandData
instance.aCommand
- instance to initialize the EPPFeeCommandData
instance with.public EPPFeeCommandData(Command aCommand)
EPPFeeCommand
instance with a defined command value.aCommand
- Command value.public EPPFeeCommandData(Command aCommand, java.lang.String aCustomName)
EPPFeeCommand
instance with a defined command value
and custom name value.aCommand
- Command value, which should be Command.CUSTOM
.aCustomName
- Custom name of the command.public EPPFeeCommandData(Command aCommand, Phase aPhase)
EPPFeeCommand
instance with a defined command and
phase value.aCommand
- Command value.aPhase
- Phase value.public EPPFeeCommandData(Command aCommand, Phase aPhase, java.lang.String aSubPhase)
EPPFeeCommand
instance with a defined command, phase,
and sub-phase value.aCommand
- Command value.aPhase
- Phase value.aSubPhase
- Sub-phase valuepublic EPPFeeCommandData(Command aCommand, java.lang.String aCustomName, Phase aPhase, java.lang.String aSubPhase, boolean aStandard, EPPFeePeriod aPeriod, java.util.List<EPPFeeValue> aFees, java.util.List<EPPFeeCredit> aCredits, java.lang.String aReason, java.lang.String aLanguage)
EPPFeeCommand
instance with all attributes.aCommand
- Command value, which should be Command.CUSTOM
.aCustomName
- Custom name of the command.aPhase
- Phase for command. Set to null
for no phase.aSubPhase
- Sub-phase for command. Set to null
for no
sub-phase.aStandard
- Command used the standard fee.aPeriod
- Period for command. Set to null
for no period.aFees
- Fees for command. Set to null
for no fees.aCredits
- Credits for command. Set to null
for no credits.aReason
- Reason that the fee information is not available for command.
Set to null
for no reason.aLanguage
- Language for reason with default of "en". Set to
null
to use default language.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 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 java.lang.String getLanguage()
public void setLanguage(java.lang.String aLanguage)
aLanguage
- Sets domain reason language attribute.public boolean isStandard()
true
if it is a standard fee command;
false
otherwise.public void setStandard(boolean aStandard)
aStandard
- Set to true
if the fee is refundable,
false
, or null
if undefined.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPFeeCommand
instance.clone
in interface EPPCodecComponent
clone
in class EPPFeeCommand
EPPFeeCommand
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPFeeCommand
element aElement DOM Element tree.decode
in interface EPPCodecComponent
decode
in class EPPFeeCommand
aElement
- - Root DOM Element to decode EPPFeeCommand
from.EPPDecodeException
- Unable to decode aElementpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPFeeCommand
instance.encode
in interface EPPCodecComponent
encode
in class EPPFeeCommand
aDocument
- - DOM Document that is being built. Used as an Element factory.EPPFeeCommand
instance.EPPEncodeException
- - Unable to encode EPPFeeCommand
instance.public boolean equals(java.lang.Object aObject)
EPPFeeCommand
compare.equals
in class EPPFeeCommand
aObject
- EPPFeeCommand
instance to compare withtrue
if equal; false
otherwisepublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.toString
in class EPPFeeCommand
String
if successful; ERROR
otherwise.Copyright © VeriSign Inc. All Rights Reserved.