Package com.verisign.epp.codec.domain
Class EPPDomainCheckResult
- java.lang.Object
-
- com.verisign.epp.codec.domain.EPPDomainCheckResult
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPDomainCheckResult extends java.lang.Object implements EPPCodecComponent
EPPDomainCheckResult
represents the result of an individual domain name check. The attributes ofEPPDomainCheckResult
include the domain name and a boolean value indicating if the domain name is available.domain reason
must be set before invokingencode
if the available flag is set tofalse
.- See Also:
EPPDomainCheckResp
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EPPDomainCheckResult()
Default constructor forEPPDomainCheckResult
.EPPDomainCheckResult(java.lang.String aName, boolean aIsAvailable)
Constructor forEPPDomainCheckResult
that includes the domain name and the available flag.EPPDomainCheckResult(java.lang.String aName, boolean aIsAvailable, java.lang.String aReason)
Constructor forEPPDomainCheckResult
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 forEPPDomainCheckResult
that includes all attributes.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPDomainCheckResult
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPDomainCheckResult
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 theEPPDomainCheckResult
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPDomainPingResp
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 theEPPCodecComponent
.boolean
isAvailable()
Gets if the domain associated withEPPDomainCheckResult
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 withisAvailable()
.void
setDomainReason(java.lang.String aReason)
Sets domain reason.void
setIsAvailable(boolean aIsAvailable)
Sets if the domain associated withEPPDomainCheckResult
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 withsetIsAvailable(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 ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Constructor Detail
-
EPPDomainCheckResult
public EPPDomainCheckResult()
Default constructor forEPPDomainCheckResult
. the defaults include the following:
-
name is set to
null
-
available is set to
true
The name must be set before invokingencode
. -
name is set to
-
EPPDomainCheckResult
public EPPDomainCheckResult(java.lang.String aName, boolean aIsAvailable)
Constructor forEPPDomainCheckResult
that includes the domain name and the available flag.- Parameters:
aName
- Domain name associated with resultaIsAvailable
- Is the domain available?
-
EPPDomainCheckResult
public EPPDomainCheckResult(java.lang.String aName, boolean aIsAvailable, java.lang.String aReason)
Constructor forEPPDomainCheckResult
that includes the domain name, availability flag, and the availability reason.- Parameters:
aName
- Domain name associated with resultaIsAvailable
- Is the domain available?aReason
- Reason that domain is not available
-
EPPDomainCheckResult
public EPPDomainCheckResult(java.lang.String aName, boolean aIsAvailable, java.lang.String aReason, java.lang.String aLanguage)
Constructor forEPPDomainCheckResult
that includes all attributes.- Parameters:
aName
- Domain name associated with resultaIsAvailable
- Is the domain available?aReason
- Reason that domain is not availableaLanguage
- Language of theaReason
value.
-
-
Method Detail
-
getName
public java.lang.String getName()
Gets the domain name associated with the result.- Returns:
- Domain name associated with the result if defined;
null
otherwise.
-
setName
public void setName(java.lang.String aName)
Sets the domain name associated with the result.- Parameters:
aName
- Domain Name associated with the result.
-
isKnown
@Deprecated public boolean isKnown()
Deprecated.As of EPP 1.0, replaced withisAvailable()
.Gets if the domain associated withEPPDomainCheckResult
is known.- Returns:
- Is the domain known?
-
setIsKnown
@Deprecated public void setIsKnown(boolean aIsKnown)
Deprecated.As of EPP 1.0, replaced withsetIsAvailable(boolean)
.Sets if the domain associated withEPPDomainCheckResult
is known.- Parameters:
aIsKnown
- Is the domain known?
-
isAvailable
public boolean isAvailable()
Gets if the domain associated withEPPDomainCheckResult
is availability (can it be provisioned or not) at the moment the <check> command was completed.- Returns:
- Is the domain available? If
false
, callgetDomainReason()
for inavailability reason.
-
setIsAvailable
public void setIsAvailable(boolean aIsAvailable)
Sets if the domain associated withEPPDomainCheckResult
is availability (can it be provisioned or not) at the moment the <check> command was completed.- Parameters:
aIsAvailable
- Is the domain available?
-
setDomainReason
public void setDomainReason(java.lang.String aReason)
Sets domain reason. This should be set if the available flag is set tofalse
.- Parameters:
aReason
- Domain Reason.
-
getDomainReason
public java.lang.String getDomainReason()
Gets domain reason. This should be set if the available flag is set tofalse
.- Returns:
- String of domain reason.
-
setLanguage
public void setLanguage(java.lang.String aLang)
Sets language attribute.- Parameters:
aLang
- Sets domain reason language attribute.
-
getLanguage
public java.lang.String getLanguage()
Gets reason language.- Returns:
- reason language.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPDomainCheckResult
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPDomainCheckResult
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPDomainCheckResult
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPDomainCheckResult
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPDomainCheckResult
from.- Throws:
EPPDecodeException
- Unable to decode aElement.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPDomainPingResp
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPDomainCheckResult
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPDomainCheckResult
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-