Package com.verisign.epp.codec.contact
Class EPPContactCheckResult
- java.lang.Object
-
- com.verisign.epp.codec.contact.EPPContactCheckResult
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPContactCheckResult extends java.lang.Object implements EPPCodecComponent
EPPContactCheckResult
represents the result of an individual contact id check. The attributes ofEPPContactCheckResult
include the contact id and a boolean value indicating if the contact id is available by the server.contact reason
must be set before invokingencode
if the available flag is set tofalse
.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EPPContactCheckResult()
Default constructor forEPPContactCheckResult
.EPPContactCheckResult(java.lang.String aId, boolean aIsAvailable)
Constructor forEPPContactCheckResult
that includes the contact id and the is available flag.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPContactCheckResult
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPContactCheckResult
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 theEPPContactCheckResult
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPContactCheckResult
with this instance.java.lang.String
getContactReason()
Gets domain reason to check.java.lang.String
getId()
Gets the contact id associated with the result.java.lang.String
getLanguage()
Sets contact reason to check.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.boolean
isAvailable()
Gets if the contact associated withEPPContactCheckResult
is available.void
setContactReason(java.lang.String aReason)
Sets domain reason.void
setId(java.lang.String aId)
Sets the contact id associated with the result.void
setIsAvailable(boolean aIsAvailable)
Sets if the contact associated withEPPContactCheckResult
is available.void
setLanguage(java.lang.String aLang)
Sets language attribute.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Constructor Detail
-
EPPContactCheckResult
public EPPContactCheckResult()
Default constructor forEPPContactCheckResult
. the defaults include the following:
-
id is set to
null
-
available is set to
true
The id must be set before invokingencode
. -
id is set to
-
EPPContactCheckResult
public EPPContactCheckResult(java.lang.String aId, boolean aIsAvailable)
Constructor forEPPContactCheckResult
that includes the contact id and the is available flag.- Parameters:
aId
- Contact id associated with resultaIsAvailable
- Is the contact id available?
-
-
Method Detail
-
getId
public java.lang.String getId()
Gets the contact id associated with the result.- Returns:
- Contact id associated with the result if defined;
null
otherwise.
-
setId
public void setId(java.lang.String aId)
Sets the contact id associated with the result.- Parameters:
aId
- Contact Id associated with the result.
-
isAvailable
public boolean isAvailable()
Gets if the contact associated withEPPContactCheckResult
is available.- Returns:
- Is the contact available?
-
setIsAvailable
public void setIsAvailable(boolean aIsAvailable)
Sets if the contact associated withEPPContactCheckResult
is available.- Parameters:
aIsAvailable
- Is the contact available?
-
setLanguage
public void setLanguage(java.lang.String aLang)
Sets language attribute.- Parameters:
aLang
- Sets contact reason language attribute.
-
getLanguage
public java.lang.String getLanguage()
Sets contact reason to check.- Returns:
- String of domain reason language.
-
setContactReason
public void setContactReason(java.lang.String aReason)
Sets domain reason.- Parameters:
aReason
- Contact Reason to check.
-
getContactReason
public java.lang.String getContactReason()
Gets domain reason to check.- Returns:
- String of contact reason
String
's.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPContactCheckResult
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
EPPContactCheckResult
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPContactCheckResult
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPContactCheckResult
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPContactPingResult
from.- Throws:
EPPDecodeException
- Unable to decode aElement.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPContactCheckResult
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
CloneEPPContactCheckResult
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPContactCheckResult
- 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
.
-
-