Package com.verisign.epp.codec.contact

Class EPPContactCheckResult

java.lang.Object
com.verisign.epp.codec.contact.EPPContactCheckResult
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPContactCheckResult extends 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.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPContactCheckResult()
    Default constructor for EPPContactCheckResult.
    EPPContactCheckResult(String aId, boolean aIsAvailable)
    Constructor for EPPContactCheckResult that includes the contact id and the is available flag.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPContactCheckResult.
    void
    decode(Element aElement)
    Decode the EPPContactCheckResult attributes from the aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPContactCheckResult instance.
    boolean
    equals(Object aObject)
    Compare an instance of EPPContactCheckResult with this instance.
    String
    getContactReason()
    Gets domain reason to check.
    String
    getId()
    Gets the contact id associated with the result.
    String
    getLanguage()
    Sets contact reason to check.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    boolean
    isAvailable()
    Gets if the contact associated with EPPContactCheckResult is available.
    void
    setContactReason(String aReason)
    Sets domain reason.
    void
    setId(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(String aLang)
    Sets language attribute.
    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

    • EPPContactCheckResult

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

      • id is set to null
      • available is set to true

      The id must be set before invoking encode.

    • EPPContactCheckResult

      public EPPContactCheckResult(String aId, boolean aIsAvailable)
      Constructor for EPPContactCheckResult that includes the contact id and the is available flag.
      Parameters:
      aId - Contact id associated with result
      aIsAvailable - Is the contact id available?

  • Method Details

    • getId

      public 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(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 with EPPContactCheckResult is available.
      Returns:
      Is the contact available?

    • setIsAvailable

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

    • setLanguage

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

    • getLanguage

      public String getLanguage()
      Sets contact reason to check.
      Returns:
      String of domain reason language.

    • setContactReason

      public void setContactReason(String aReason)
      Sets domain reason.
      Parameters:
      aReason - Contact Reason to check.

    • getContactReason

      public String getContactReason()
      Gets domain reason to check.
      Returns:
      String of contact reason String's.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPContactCheckResult 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 EPPContactCheckResult instance.
      Throws:
      EPPEncodeException - Unable to encode EPPContactCheckResult instance.

    • decode

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPContactCheckResult with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      DOCUMENT ME!

    • clone

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

    • 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.