public class EPPFeeCheckResult extends java.lang.Object implements EPPCodecComponent
EPPFeeCheckResult
represents a fee result to a check.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPFeeCheckResult . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPFeeCheckResult . |
Constructor and Description |
---|
EPPFeeCheckResult()
Default constructor for
EPPFeeCheckResult . |
EPPFeeCheckResult(java.lang.String aObjID,
boolean aAvailable)
Constructor for
EPPFeeCheckResult that only takes the
identifier (domain name) and the available flag. |
EPPFeeCheckResult(java.lang.String aObjID,
EPPFeeCommandData aCommand)
Constructor for
EPPFeeCheckResult that takes the identifier
(domain name) and a single command for an available fee. |
EPPFeeCheckResult(java.lang.String aObjID,
java.util.List<EPPFeeCommandData> aCommands)
Constructor for
EPPFeeCheckResult that takes the object
identifier (domain name) and a list of commands for an available fee. |
EPPFeeCheckResult(java.lang.String aObjID,
java.lang.String aReason)
Constructor for
EPPFeeCheckResult that takes the object
identifier (domain name) and the reason that the fee data is unavailable. |
EPPFeeCheckResult(java.lang.String aObjID,
java.lang.String aReason,
java.lang.String aLanguage)
Constructor for
EPPFeeCheckResult that takes the object
identifier (domain name), the reason that the fee data is unavailable, and
the language of the reason. |
Modifier and Type | Method and Description |
---|---|
void |
addCommand(EPPFeeCommandData aCommand)
Adds a command to the list of commands.
|
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
EPPFeeCheckResult with this instance. |
java.util.List<EPPFeeCommandData> |
getCommands()
Gets the list of commands if defined.
|
java.lang.String |
getLanguage()
Gets reason language
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getObjID()
Gets the object identifier value.
|
java.lang.String |
getReason()
Gets the reason value.
|
boolean |
hasCommands()
Are the commands 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 |
setCommands(java.util.List<EPPFeeCommandData> aCommands)
Sets the list of commands.
|
void |
setLanguage(java.lang.String aLanguage)
Sets language attribute.
|
void |
setObjID(java.lang.String aObjID)
Sets the name 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
EPPFeeCheckResult
.public static final java.lang.String ELM_NAME
EPPFeeCheckResult
.public EPPFeeCheckResult()
EPPFeeCheckResult
.public EPPFeeCheckResult(java.lang.String aObjID, boolean aAvailable)
EPPFeeCheckResult
that only takes the
identifier (domain name) and the available flag.aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aAvailable
- Fee available flag. If true
, at least one fee
command data element must be set and if false
a
reason should be set.public EPPFeeCheckResult(java.lang.String aObjID, EPPFeeCommandData aCommand)
EPPFeeCheckResult
that takes the identifier
(domain name) and a single command for an available fee.aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aCommand
- Command fee datapublic EPPFeeCheckResult(java.lang.String aObjID, java.util.List<EPPFeeCommandData> aCommands)
EPPFeeCheckResult
that takes the object
identifier (domain name) and a list of commands for an available fee.aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aCommands
- Command fee datapublic EPPFeeCheckResult(java.lang.String aObjID, java.lang.String aReason)
EPPFeeCheckResult
that takes the object
identifier (domain name) and the reason that the fee data is unavailable.aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aReason
- Reason that the fee data is unavailable.public EPPFeeCheckResult(java.lang.String aObjID, java.lang.String aReason, java.lang.String aLanguage)
EPPFeeCheckResult
that takes the object
identifier (domain name), the reason that the fee data is unavailable, and
the language of the reason.aObjID
- Object identifier. An example is the domain name for extension
of a domain check response.aReason
- Reason that the fee data is unavailable.aLanguage
- Language of the aReason
value.public 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 boolean hasCommands()
true
if the commands are defined; false
otherwise.public java.util.List<EPPFeeCommandData> getCommands()
public void addCommand(EPPFeeCommandData aCommand)
aCommand
- The command to add.public void setCommands(java.util.List<EPPFeeCommandData> aCommands)
aCommands
- The commands 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 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 EPPFeeCheckResult
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
EPPFeeCheckResult
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)
EPPFeeCheckResult
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.