Class EPPRegistryCheckResult
- java.lang.Object
-
- com.verisign.epp.codec.registry.v02.EPPRegistryCheckResult
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPRegistryCheckResult extends java.lang.Object implements EPPCodecComponent
EPPRegistryCheckResult
provides the result of checking the availability of an individual zone.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPRegistryInfoResp
.static java.lang.String
ELM_NAME
XML root tag forEPPRegistryCheckResult
.
-
Constructor Summary
Constructors Constructor Description EPPRegistryCheckResult()
Creates a newEPPRegistryCheckResult
object with an empty zone name and availability set totrue
.EPPRegistryCheckResult(EPPRegistryZoneName aName, java.lang.Boolean aAvailable)
Creates a newEPPRegistryCheckResult
object with a defined zone name and available value.EPPRegistryCheckResult(EPPRegistryZoneName aName, java.lang.Boolean aAvailable, java.lang.String aReason)
Creates a newEPPRegistryCheckResult
object with a defined zone name, available value, and reason.EPPRegistryCheckResult(java.lang.String aName, java.lang.Boolean aAvailable)
Creates a newEPPRegistryCheckResult
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 newEPPRegistryCheckResult
object with a defined aLabel zone name, available value, and reason.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPRegistryCheckResult
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPRegistryCheckResult
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 theEPPRegistryCheckResult
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPRegistryCheckResult
with this instance.java.lang.String
getLanguage()
Gets the unavailable reason language with the default value ofVALUE_LANG
.EPPRegistryZoneName
getName()
Gets the zone name.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.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 ofVALUE_LANG
.void
setName(EPPRegistryZoneName aName)
Sets the zone namevoid
setName(java.lang.String aName)
Sets the aLabel zone namevoid
setReason(java.lang.String aReason)
Sets the unavailable reason.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPRegistryInfoResp
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPRegistryCheckResult
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPRegistryCheckResult
public EPPRegistryCheckResult()
Creates a newEPPRegistryCheckResult
object with an empty zone name and availability set totrue
. The Zone name must be set viasetName(String)
prior to callingencode(Document)
.
-
EPPRegistryCheckResult
public EPPRegistryCheckResult(java.lang.String aName, java.lang.Boolean aAvailable)
Creates a newEPPRegistryCheckResult
object with a defined aLabel zone name and available value.- Parameters:
aName
- aLabel zone nameaAvailable
-true
if available;false
otherwise.
-
EPPRegistryCheckResult
public EPPRegistryCheckResult(EPPRegistryZoneName aName, java.lang.Boolean aAvailable)
Creates a newEPPRegistryCheckResult
object with a defined zone name and available value.- Parameters:
aName
- Zone nameaAvailable
-true
if available;false
otherwise.
-
EPPRegistryCheckResult
public EPPRegistryCheckResult(java.lang.String aName, java.lang.Boolean aAvailable, java.lang.String aReason)
Creates a newEPPRegistryCheckResult
object with a defined aLabel zone name, available value, and reason.- Parameters:
aName
- aLabel zone nameaAvailable
- Should be set tofalse
for this constructor.aReason
- Reason Unavailable reason using the default language ofVALUE_LANG
.
-
EPPRegistryCheckResult
public EPPRegistryCheckResult(EPPRegistryZoneName aName, java.lang.Boolean aAvailable, java.lang.String aReason)
Creates a newEPPRegistryCheckResult
object with a defined zone name, available value, and reason.- Parameters:
aName
- Zone nameaAvailable
- Should be set tofalse
for this constructor.aReason
- Reason Unavailable reason using the default language ofVALUE_LANG
.
-
-
Method Detail
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPRegistryCheckResult
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
EPPRegistryCheckResult
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPRegistryCheckResult
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPRegistryCheckResult
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPRegistryCheckResult
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPRegistryCheckResult
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPRegistryCheckResult
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPRegistryCheckResult
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
true
if this object is the same as the aObject argument;false
otherwise
-
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.
-
getLanguage
public java.lang.String getLanguage()
Gets the unavailable reason language with the default value ofVALUE_LANG
.- Returns:
- Unavailable reason langauge with the default value of
VALUE_LANG
.
-
setLanguage
public void setLanguage(java.lang.String aLanguage)
Sets the unavailable reason language with the default value ofVALUE_LANG
.- Parameters:
aLanguage
- Language of the unavailable reason set withsetReason(String)
.
-
getName
public EPPRegistryZoneName getName()
Gets the zone name.- Returns:
- Zone name if set;
null
otherwise.
-
setName
public void setName(EPPRegistryZoneName aName)
Sets the zone name- Parameters:
aName
- Zone name
-
setName
public void setName(java.lang.String aName)
Sets the aLabel zone name- Parameters:
aName
- aLabel zone name
-
isAvailable
public java.lang.Boolean isAvailable()
Gets the zone available.- Returns:
true
if available;false
otherwise.
-
setAvailable
public void setAvailable(java.lang.Boolean aAvailable)
Sets the zone available.- Parameters:
aAvailable
-true
if available;false
otherwise.
-
getReason
public java.lang.String getReason()
- Returns:
- The unavailable reason if set;
null
otherwise.
-
setReason
public void setReason(java.lang.String aReason)
- Parameters:
aReason
- Unavailable reason. Set tonull
if zone is available.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-