Package com.verisign.epp.codec.emailFwd
Class EPPEmailFwdCheckResult
- java.lang.Object
-
- com.verisign.epp.codec.emailFwd.EPPEmailFwdCheckResult
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPEmailFwdCheckResult extends java.lang.Object implements EPPCodecComponent
EPPEmailFwdCheckResult
represents the result of an individual emailFwd name ping. The attributes ofEPPEmailFwdCheckResult
include the emailFwd name and a boolean value indicating if the emailFwd name is already available.emailFwd reason
must be set before invokingencode
if the available flag is set tofalse
.- See Also:
EPPEmailFwdCheckResp
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EPPEmailFwdCheckResult()
Default constructor forEPPEmailFwdCheckResult
.EPPEmailFwdCheckResult(java.lang.String aName, boolean aIsAvailable)
Constructor forEPPEmailFwdCheckResult
that includes the emailFwd name and the is available flag.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPEmailFwdCheckResult
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPEmailFwdCheckResult
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 theEPPEmailFwdCheckResult
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPEmailFwdPingResp
with this instance.java.lang.String
getEmailFwdReason()
Gets emailFwd reason.java.lang.String
getLanguage()
Sets emailFwd reason to check.java.lang.String
getName()
Gets the emailFwd name associated with the result.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.boolean
isAvailable()
Gets if the emailFwd associated withEPPEmailFwdCheckResult
is available.void
setEmailFwdReason(java.lang.String aReason)
Sets emailFwd reason.void
setIsAvailable(boolean aIsAvailable)
Sets if the emailFwd associated withEPPEmailFwdCheckResult
is available.void
setLanguage(java.lang.String aLang)
Sets language attribute.void
setName(java.lang.String aName)
Sets the emailFwd 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
-
EPPEmailFwdCheckResult
public EPPEmailFwdCheckResult()
Default constructor forEPPEmailFwdCheckResult
. 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
-
EPPEmailFwdCheckResult
public EPPEmailFwdCheckResult(java.lang.String aName, boolean aIsAvailable)
Constructor forEPPEmailFwdCheckResult
that includes the emailFwd name and the is available flag.- Parameters:
aName
- EmailFwd name associated with resultaIsAvailable
- Is the emailFwd name available?
-
-
Method Detail
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPEmailFwdCheckResult
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPEmailFwdCheckResult
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPEmailFwdCheckResult
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPEmailFwdCheckResult
from.- Throws:
EPPDecodeException
- Unable to decode aElement.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPEmailFwdCheckResult
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
EPPEmailFwdCheckResult
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPEmailFwdCheckResult
instance.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPEmailFwdPingResp
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
true
if the objects are equal;false
otherwise.
-
getEmailFwdReason
public java.lang.String getEmailFwdReason()
Gets emailFwd reason.- Returns:
- String of emailFwd reason if defined;
null
otherwise.
-
getLanguage
public java.lang.String getLanguage()
Sets emailFwd reason to check.- Returns:
- String of emailFwd reason language if defined;
nuill
otherwise.
-
getName
public java.lang.String getName()
Gets the emailFwd name associated with the result.- Returns:
- EmailFwd name associated with the result if defined;
null
otherwise.
-
isAvailable
public boolean isAvailable()
Gets if the emailFwd associated withEPPEmailFwdCheckResult
is available.- Returns:
- Is the emailFwd available?
-
setEmailFwdReason
public void setEmailFwdReason(java.lang.String aReason)
Sets emailFwd reason.- Parameters:
aReason
- EmailFwd Reason.
-
setIsAvailable
public void setIsAvailable(boolean aIsAvailable)
Sets if the emailFwd associated withEPPEmailFwdCheckResult
is available.- Parameters:
aIsAvailable
- Is the emailFwd available?
-
setLanguage
public void setLanguage(java.lang.String aLang)
Sets language attribute.- Parameters:
aLang
- Sets emailFwd reason language attribute.
-
setName
public void setName(java.lang.String aName)
Sets the emailFwd name associated with the result.- Parameters:
aName
- EmailFwd Name associated with the result.
-
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
.
-
-