Package com.verisign.epp.codec.emailFwd

Class EPPEmailFwdCheckResult

java.lang.Object
com.verisign.epp.codec.emailFwd.EPPEmailFwdCheckResult
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPEmailFwdCheckResult extends Object implements EPPCodecComponent
EPPEmailFwdCheckResult represents the result of an individual emailFwd name ping. The attributes of EPPEmailFwdCheckResult include the emailFwd name and a boolean value indicating if the emailFwd name is already available. emailFwd reason must be set before invoking encode if the available flag is set to false.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPEmailFwdCheckResult()
    Default constructor for EPPEmailFwdCheckResult.
    EPPEmailFwdCheckResult(String aName, boolean aIsAvailable)
    Constructor for EPPEmailFwdCheckResult that includes the emailFwd name and the is available flag.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPEmailFwdCheckResult.
    void
    decode(Element aElement)
    Decode the EPPEmailFwdCheckResult attributes from the aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPEmailFwdCheckResult instance.
    boolean
    equals(Object aObject)
    Compare an instance of EPPEmailFwdPingResp with this instance.
    String
    getEmailFwdReason()
    Gets emailFwd reason.
    String
    getLanguage()
    Sets emailFwd reason to check.
    String
    getName()
    Gets the emailFwd name associated with the result.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    boolean
    isAvailable()
    Gets if the emailFwd associated with EPPEmailFwdCheckResult is available.
    void
    setEmailFwdReason(String aReason)
    Sets emailFwd reason.
    void
    setIsAvailable(boolean aIsAvailable)
    Sets if the emailFwd associated with EPPEmailFwdCheckResult is available.
    void
    setLanguage(String aLang)
    Sets language attribute.
    void
    setName(String aName)
    Sets the emailFwd name associated with the result.
    String
    toString()
    Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • EPPEmailFwdCheckResult

      public EPPEmailFwdCheckResult()
      Default constructor for EPPEmailFwdCheckResult. the defaults include the following:

      • name is set to null
      • available is set to true

      The name must be set before invoking encode.

    • EPPEmailFwdCheckResult

      public EPPEmailFwdCheckResult(String aName, boolean aIsAvailable)
      Constructor for EPPEmailFwdCheckResult that includes the emailFwd name and the is available flag.
      Parameters:
      aName - EmailFwd name associated with result
      aIsAvailable - Is the emailFwd name available?

  • Method Details

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPEmailFwdCheckResult.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPEmailFwdCheckResult
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPEmailFwdCheckResult attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPEmailFwdCheckResult from.
      Throws:
      EPPDecodeException - Unable to decode aElement.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPEmailFwdCheckResult instance.
      Specified by:
      encode in interface EPPCodecComponent
      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 encode EPPEmailFwdCheckResult instance.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPEmailFwdPingResp with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if the objects are equal; false otherwise.

    • getEmailFwdReason

      public String getEmailFwdReason()
      Gets emailFwd reason.
      Returns:
      String of emailFwd reason if defined; null otherwise.

    • getLanguage

      public String getLanguage()
      Sets emailFwd reason to check.
      Returns:
      String of emailFwd reason language if defined; nuill otherwise.

    • getName

      public 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 with EPPEmailFwdCheckResult is available.
      Returns:
      Is the emailFwd available?

    • setEmailFwdReason

      public void setEmailFwdReason(String aReason)
      Sets emailFwd reason.
      Parameters:
      aReason - EmailFwd Reason.

    • setIsAvailable

      public void setIsAvailable(boolean aIsAvailable)
      Sets if the emailFwd associated with EPPEmailFwdCheckResult is available.
      Parameters:
      aIsAvailable - Is the emailFwd available?

    • setLanguage

      public void setLanguage(String aLang)
      Sets language attribute.
      Parameters:
      aLang - Sets emailFwd reason language attribute.

    • setName

      public void setName(String aName)
      Sets the emailFwd name associated with the result.
      Parameters:
      aName - EmailFwd Name associated with the result.

    • toString

      public String toString()
      Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
      Overrides:
      toString in class Object
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.