public class EPPContactCheckResult extends java.lang.Object implements EPPCodecComponent
EPPContactCheckResult
represents the result of an individual
contact id check. The attributes of EPPContactCheckResult
include the contact id and a boolean value indicating if the contact id
is available by the server. contact reason
must be set before
invoking encode
if the available flag is set to
false
. Constructor and Description |
---|
EPPContactCheckResult()
Default constructor for
EPPContactCheckResult . |
EPPContactCheckResult(java.lang.String aId,
boolean aIsAvailable)
Constructor for
EPPContactCheckResult that includes the
contact id and the is available flag. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPContactCheckResult . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPContactCheckResult 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
EPPContactCheckResult instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPContactCheckResult 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 the
EPPCodecComponent . |
boolean |
isAvailable()
Gets if the contact associated with
EPPContactCheckResult
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 with
EPPContactCheckResult
is available. |
void |
setLanguage(java.lang.String aLang)
Sets language attribute.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public EPPContactCheckResult()
EPPContactCheckResult
. the
defaults include the following: null
true
encode
.public EPPContactCheckResult(java.lang.String aId, boolean aIsAvailable)
EPPContactCheckResult
that includes the
contact id and the is available flag.aId
- Contact id associated with resultaIsAvailable
- Is the contact id available?public java.lang.String getId()
null
otherwise.public void setId(java.lang.String aId)
aId
- Contact Id associated with the result.public boolean isAvailable()
EPPContactCheckResult
is available.public void setIsAvailable(boolean aIsAvailable)
EPPContactCheckResult
is available.aIsAvailable
- Is the contact available?public void setLanguage(java.lang.String aLang)
aLang
- Sets contact reason language attribute.public java.lang.String getLanguage()
public void setContactReason(java.lang.String aReason)
aReason
- Contact Reason to check.public java.lang.String getContactReason()
String
's.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPContactCheckResult
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element
factory.EPPContactCheckResult
instance.EPPEncodeException
- Unable to encode
EPPContactCheckResult
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPContactCheckResult
attributes from the
aElement DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode
EPPContactPingResult
from.EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPContactCheckResult
with this
instance.equals
in class java.lang.Object
aObject
- Object to compare with.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPContactCheckResult
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPContactCheckResult
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
.