public class EPPDefRegCheckResult extends java.lang.Object implements EPPCodecComponent
EPPDomainCheckResult
represents the result of an individual
defReg name ping. The attributes of EPPDomainCheckResult
include
the defReg name and attributes namely level which is either "premium" or
"standard" and boolean value indicating if the defReg name is already
available. defReg reason
must be set before invoking
encode
if the available flag is set to false
.EPPDefRegCheckResp
,
Serialized FormConstructor and Description |
---|
EPPDefRegCheckResult()
Default constructor for
EPPDefRegCheckResult . |
EPPDefRegCheckResult(java.lang.String aName,
java.lang.String aLevel,
boolean aIsAvailable)
Constructor for
EPPDefRegCheckResult that includes the defReg
name and the is available flag. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPDefRegCheckResult . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPDefRegCheckResult attributes from the aElement
DOM Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the
EPPDefRegCheckResult instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPDefRegPingResp with this instance. |
java.lang.String |
getDefRegReason()
Gets defReg reason.
|
java.lang.String |
getLanguage()
Sets defReg reason to check.
|
java.lang.String |
getLevel()
Gets the defReg level associated with the result.
|
java.lang.String |
getName()
Gets the defReg name associated with the result.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
boolean |
isAvailable()
Gets if the defReg associated with
EPPDomainCheckResult is
available. |
void |
setDefRegReason(java.lang.String aReason)
Sets defReg reason.
|
void |
setIsAvailable(boolean aIsAvailable)
Sets if the defReg associated with
EPPDefRegCheckResult is
available. |
void |
setLanguage(java.lang.String aLang)
Sets language attribute.
|
void |
setLevel(java.lang.String aLevel)
Sets the defReg level associated with the result.
|
void |
setName(java.lang.String aName)
Sets the defReg name associated with the result.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
void |
validate()
Validate the state of the
EPPDefRegCreateCmd instance. |
public EPPDefRegCheckResult()
EPPDefRegCheckResult
. the defaults
include the following: null
null
true
encode
.public EPPDefRegCheckResult(java.lang.String aName, java.lang.String aLevel, boolean aIsAvailable)
EPPDefRegCheckResult
that includes the defReg
name and the is available flag.aName
- DefReg name associated with resultaLevel
- DefReg level associated with result, which should be either
EPPDefRegName.LEVEL_STANDARD
or
EPPDefRegName.LEVEL_STANDARD
.aIsAvailable
- Is the defReg name available?public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPDefRegCheckResult
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPDefRegCheckResult
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPDefRegCheckResult
attributes from the aElement
DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPDefRegCheckResult
from.EPPDecodeException
- Unable to decode aElement.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPDefRegCheckResult
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPDefRegCheckResult
instance.EPPEncodeException
- Unable to encode EPPDefRegCheckResult
instance.public boolean equals(java.lang.Object aObject)
EPPDefRegPingResp
with this instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if the objects are equal; false
otherwise.public java.lang.String getDefRegReason()
public java.lang.String getLanguage()
public java.lang.String getLevel()
EPPDefRegName.LEVEL_STANDARD
or
EPPDefRegName.LEVEL_STANDARD
,null
otherwise.public java.lang.String getName()
null
otherwise.public boolean isAvailable()
EPPDomainCheckResult
is
available.public void setDefRegReason(java.lang.String aReason)
aReason
- DefReg Reason.public void setIsAvailable(boolean aIsAvailable)
EPPDefRegCheckResult
is
available.aIsAvailable
- Is the defReg available?public void setLanguage(java.lang.String aLang)
aLang
- Sets defReg reason language attribute.public void setLevel(java.lang.String aLevel)
aLevel
- DefReg Level associated with the result, which should be either
EPPDefRegName.LEVEL_STANDARD
or
EPPDefRegName.LEVEL_STANDARD
.public void setName(java.lang.String aName)
aName
- DefReg Name associated with the result.public 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 void validate() throws EPPEncodeException
EPPDefRegCreateCmd
instance. A
valid state means that all of the required attributes have been set. If
validateState returns without an exception, the state is valid. If the
state is not valid, the EPPCodecException
will contain a
description of the error. throws EPPCodecException State error. This will
contain the name of the attribute that is not valid.EPPEncodeException
- DOCUMENT ME!public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.