public class EPPHostCheckResult extends java.lang.Object implements EPPCodecComponent
EPPHostCheckResult
represents the result of an individual
host name check. The attributes of EPPHostCheckResult
include the domain name and a boolean value indicating if the domain
name is available. host reason
must be set before
invoking encode
if the available flag is set to
false
. EPPHostCheckResp
,
Serialized FormConstructor and Description |
---|
EPPHostCheckResult()
Default constructor for
EPPHostCheckResult . |
EPPHostCheckResult(java.lang.String aName,
boolean isAvailable)
Constructor for
EPPHostCheckResult that includes the
domain name and the is known flag. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPHostCheckResult . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPHostCheckResult 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
EPPHostCheckResult instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPHostCheckResult with this
instance. |
java.lang.String |
getHostReason()
Gets host reason.
|
java.lang.String |
getLanguage()
Sets domain reason to check.
|
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
EPPHostCheckResult 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 |
setHostReason(java.lang.String aReason)
Sets host reason.
|
void |
setIsAvailable(boolean aIsAvailable)
Sets if the host associated with
EPPHostCheckResult 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 EPPHostCheckResult()
EPPHostCheckResult
. the
defaults include the following: null
false
encode
.public EPPHostCheckResult(java.lang.String aName, boolean isAvailable)
EPPHostCheckResult
that includes the
domain name and the is known flag.aName
- Domain name associated with resultisAvailable
- Is the domain name available?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()
.EPPHostCheckResult
is
known.public void setIsKnown(boolean aIsKnown)
setIsAvailable(boolean)
.EPPHostCheckResult
is
known.aIsKnown
- Is the domain known?public boolean isAvailable()
EPPHostCheckResult
is
availability (can it be provisioned or not) at the moment the
<check> command was completed.false
, call getHostReason()
for inavailability reason.public void setIsAvailable(boolean aIsAvailable)
EPPHostCheckResult
is
availability (can it be provisioned or not) at the moment the
<check> command was completed.aIsAvailable
- Is the host available?public void setHostReason(java.lang.String aReason)
aReason
- Host Reason.public java.lang.String getHostReason()
public void setLanguage(java.lang.String aLang)
aLang
- Sets value of language attribute.public java.lang.String getLanguage()
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPHostCheckResult
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element
factory.EPPHostCheckResult
instance.EPPEncodeException
- Unable to encode
EPPHostCheckResult
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPHostCheckResult
attributes from the aElement
DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode
EPPHostCheckResult
from.EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPHostCheckResult
with this
instance.equals
in class java.lang.Object
aObject
- Object to compare with.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPHostCheckResult
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPHostCheckResult
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
.Copyright © VeriSign Inc. All Rights Reserved.