public class EPPRegistryCheckResult extends java.lang.Object implements EPPCodecComponent
EPPRegistryCheckResult
provides the result of checking the
availability of an individual zone.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPRegistryInfoResp . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPRegistryCheckResult . |
Constructor and Description |
---|
EPPRegistryCheckResult()
Creates a new
EPPRegistryCheckResult object with an empty zone
name and availability set to true . |
EPPRegistryCheckResult(EPPRegistryZoneName aName,
java.lang.Boolean aAvailable)
Creates a new
EPPRegistryCheckResult object with a defined zone
name and available value. |
EPPRegistryCheckResult(EPPRegistryZoneName aName,
java.lang.Boolean aAvailable,
java.lang.String aReason)
Creates a new
EPPRegistryCheckResult object with a defined zone
name, available value, and reason. |
EPPRegistryCheckResult(java.lang.String aName,
java.lang.Boolean aAvailable)
Creates a new
EPPRegistryCheckResult object with a defined aLabel
zone name and available value. |
EPPRegistryCheckResult(java.lang.String aName,
java.lang.Boolean aAvailable,
java.lang.String aReason)
Creates a new
EPPRegistryCheckResult object with a defined aLabel
zone name, available value, and reason. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPRegistryCheckResult . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPRegistryCheckResult 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
EPPRegistryCheckResult instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPRegistryCheckResult with this instance. |
java.lang.String |
getLanguage()
Gets the unavailable reason language with the default value of
VALUE_LANG . |
EPPRegistryZoneName |
getName()
Gets the zone name.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getReason()
Gets the unavailable reason.
|
java.lang.Boolean |
isAvailable()
Gets the zone available.
|
void |
setAvailable(java.lang.Boolean aAvailable)
Sets the zone available.
|
void |
setLanguage(java.lang.String aLanguage)
Sets the unavailable reason language with the default value of
VALUE_LANG . |
void |
setName(EPPRegistryZoneName aName)
Sets the zone name
|
void |
setName(java.lang.String aName)
Sets the aLabel zone name
|
void |
setReason(java.lang.String aReason)
Sets the unavailable reason.
|
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
EPPRegistryInfoResp
.public static final java.lang.String ELM_NAME
EPPRegistryCheckResult
.public EPPRegistryCheckResult()
EPPRegistryCheckResult
object with an empty zone
name and availability set to true
. The Zone name must be set via
setName(String)
prior to calling encode(Document)
.public EPPRegistryCheckResult(java.lang.String aName, java.lang.Boolean aAvailable)
EPPRegistryCheckResult
object with a defined aLabel
zone name and available value.aName
- aLabel zone nameaAvailable
- true
if available; false
otherwise.public EPPRegistryCheckResult(EPPRegistryZoneName aName, java.lang.Boolean aAvailable)
EPPRegistryCheckResult
object with a defined zone
name and available value.aName
- Zone nameaAvailable
- true
if available; false
otherwise.public EPPRegistryCheckResult(java.lang.String aName, java.lang.Boolean aAvailable, java.lang.String aReason)
EPPRegistryCheckResult
object with a defined aLabel
zone name, available value, and reason.aName
- aLabel zone nameaAvailable
- Should be set to false
for this constructor.aReason
- Reason Unavailable reason using the default language of
VALUE_LANG
.public EPPRegistryCheckResult(EPPRegistryZoneName aName, java.lang.Boolean aAvailable, java.lang.String aReason)
EPPRegistryCheckResult
object with a defined zone
name, available value, and reason.aName
- Zone nameaAvailable
- Should be set to false
for this constructor.aReason
- Reason Unavailable reason using the default language of
VALUE_LANG
.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRegistryCheckResult
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPRegistryCheckResult
instance.EPPEncodeException
- Unable to encode EPPRegistryCheckResult
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRegistryCheckResult
attributes from the aElement DOM
Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPRegistryCheckResult
from.EPPDecodeException
- Unable to decode aElementpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRegistryCheckResult
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPRegistryCheckResult
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic boolean equals(java.lang.Object aObject)
EPPRegistryCheckResult
with this instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if this object is the same as the aObject argument;
false
otherwisepublic 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 java.lang.String getLanguage()
VALUE_LANG
.VALUE_LANG
.public void setLanguage(java.lang.String aLanguage)
VALUE_LANG
.aLanguage
- Language of the unavailable reason set with
setReason(String)
.public EPPRegistryZoneName getName()
null
otherwise.public void setName(EPPRegistryZoneName aName)
aName
- Zone namepublic void setName(java.lang.String aName)
aName
- aLabel zone namepublic java.lang.Boolean isAvailable()
true
if available; false
otherwise.public void setAvailable(java.lang.Boolean aAvailable)
aAvailable
- true
if available; false
otherwise.public java.lang.String getReason()
null
otherwise.public void setReason(java.lang.String aReason)
aReason
- Unavailable reason. Set to null
if zone is available.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.