public class EPPDomainCheckResult extends java.lang.Object implements EPPCodecComponent
EPPDomainCheckResult
represents the result of an individual
domain name check. The attributes of EPPDomainCheckResult
include the domain name and a boolean value indicating if the domain name is
available. domain reason
must be set before invoking
encode
if the available flag is set to false
.EPPDomainCheckResp
,
Serialized FormConstructor and Description |
---|
EPPDomainCheckResult()
Default constructor for
EPPDomainCheckResult . |
EPPDomainCheckResult(java.lang.String aName,
boolean aIsAvailable)
Constructor for
EPPDomainCheckResult that includes the
domain name and the available flag. |
EPPDomainCheckResult(java.lang.String aName,
boolean aIsAvailable,
java.lang.String aReason)
Constructor for
EPPDomainCheckResult that includes the
domain name, availability flag, and the availability reason. |
EPPDomainCheckResult(java.lang.String aName,
boolean aIsAvailable,
java.lang.String aReason,
java.lang.String aLanguage)
Constructor for
EPPDomainCheckResult that includes all
attributes. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPDomainCheckResult . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPDomainCheckResult 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
EPPDomainCheckResult instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPDomainPingResp with this instance. |
java.lang.String |
getDomainReason()
Gets domain reason.
|
java.lang.String |
getLanguage()
Gets reason language.
|
java.lang.String |
getName()
Gets the domain name associated with the result.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
boolean |
isAvailable()
Gets if the domain associated with
EPPDomainCheckResult is
availability (can it be provisioned or not) at the moment the
<check> command was completed. |
boolean |
isKnown()
Deprecated.
As of EPP 1.0, replaced with
isAvailable() . |
void |
setDomainReason(java.lang.String aReason)
Sets domain reason.
|
void |
setIsAvailable(boolean aIsAvailable)
Sets if the domain associated with
EPPDomainCheckResult is
availability (can it be provisioned or not) at the moment the
<check> command was completed. |
void |
setIsKnown(boolean aIsKnown)
Deprecated.
As of EPP 1.0, replaced with
setIsAvailable(boolean)
. |
void |
setLanguage(java.lang.String aLang)
Sets language attribute.
|
void |
setName(java.lang.String aName)
Sets the domain 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 . |
public EPPDomainCheckResult()
EPPDomainCheckResult
. the defaults
include the following: null
true
encode
.public EPPDomainCheckResult(java.lang.String aName, boolean aIsAvailable)
EPPDomainCheckResult
that includes the
domain name and the available flag.aName
- Domain name associated with resultaIsAvailable
- Is the domain available?public EPPDomainCheckResult(java.lang.String aName, boolean aIsAvailable, java.lang.String aReason)
EPPDomainCheckResult
that includes the
domain name, availability flag, and the availability reason.aName
- Domain name associated with resultaIsAvailable
- Is the domain available?aReason
- Reason that domain is not availablepublic EPPDomainCheckResult(java.lang.String aName, boolean aIsAvailable, java.lang.String aReason, java.lang.String aLanguage)
EPPDomainCheckResult
that includes all
attributes.aName
- Domain name associated with resultaIsAvailable
- Is the domain available?aReason
- Reason that domain is not availableaLanguage
- Language of the aReason
value.public java.lang.String getName()
null
otherwise.public void setName(java.lang.String aName)
aName
- Domain Name associated with the result.public boolean isKnown()
isAvailable()
.EPPDomainCheckResult
is
known.public void setIsKnown(boolean aIsKnown)
setIsAvailable(boolean)
.EPPDomainCheckResult
is
known.aIsKnown
- Is the domain known?public boolean isAvailable()
EPPDomainCheckResult
is
availability (can it be provisioned or not) at the moment the
<check> command was completed.false
, call
getDomainReason()
for inavailability reason.public void setIsAvailable(boolean aIsAvailable)
EPPDomainCheckResult
is
availability (can it be provisioned or not) at the moment the
<check> command was completed.aIsAvailable
- Is the domain available?public void setDomainReason(java.lang.String aReason)
false
.aReason
- Domain Reason.public java.lang.String getDomainReason()
false
.public void setLanguage(java.lang.String aLang)
aLang
- Sets domain reason language attribute.public java.lang.String getLanguage()
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPDomainCheckResult
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPDomainCheckResult
instance.EPPEncodeException
- Unable to encode EPPDomainCheckResult
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPDomainCheckResult
attributes from the aElement
DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPDomainCheckResult
from.EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPDomainPingResp
with this instance.equals
in class java.lang.Object
aObject
- Object to compare with.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPDomainCheckResult
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPDomainCheckResult
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 java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.