Package com.verisign.epp.codec.org

Class EPPOrgCheckResult

java.lang.Object
com.verisign.epp.codec.org.EPPOrgCheckResult
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPOrgCheckResult extends Object implements EPPCodecComponent
EPPOrgCheckResult is used to represent the for the check of an individual org. The org information includes the org identifier, whether the org identifier is available, and optionally the reason that the org identifier is not available.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPOrgCheckResult.
    static final String
    ELM_NAME
    XML root tag for EPPOrgCheckResult.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPOrgCheckResult()
    Default constructor for EPPOrgCheckResult.
    EPPOrgCheckResult(String aOrgId, boolean aAvailable)
    Constructor for EPPOrgCheckResult that takes org identifier and whether the org identifier is available.
    EPPOrgCheckResult(String aOrgId, String aReason)
    Constructor for EPPOrgCheckResult that is used for unavailable org identifiers providing the reason the org identifier is not available.
    EPPOrgCheckResult(String aOrgId, String aReason, String aReasonLang)
    Constructor for EPPOrgCheckResult that is used for unavailable org identifiers providing the reason the org identifier is not available with the reason language.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    clone an EPPCodecComponent.
    void
    decode(Element aElement)
    decode a DOM element tree to initialize the instance attributes.
    Element
    encode(Document aDocument)
    encode instance into a DOM element tree.
    boolean
    equals(Object aObject)
    Compare an instance of EPPOrgCheckResult with this instance.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getOrgId()
    Gets the org identifier.
    String
    getReason()
    Gets the reason that the org identifier is not available.
    String
    getReasonLang()
    Gets the reason language value.
    boolean
    hasReason()
    Is the reason defined?
    boolean
    hasReasonLang()
    Is the reason language defined?
    boolean
    isAvailable()
    Is the org identifier available?
    void
    setAvailable(boolean aAvailable)
    Sets the org identifier is available.
    void
    setOrgId(String aOrgId)
    Sets the org identifier.
    void
    setReason(String aReason)
    Sets the reason that the org identifier is not available.
    void
    setReasonLang(String aReasonLang)
    Sets the reason language value.
    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

  • Field Details

  • Constructor Details

    • EPPOrgCheckResult

      public EPPOrgCheckResult()
      Default constructor for EPPOrgCheckResult.

    • EPPOrgCheckResult

      public EPPOrgCheckResult(String aOrgId, boolean aAvailable)
      Constructor for EPPOrgCheckResult that takes org identifier and whether the org identifier is available.
      Parameters:
      aOrgId - The org identifier
      aAvailable - Is the org identifier available?

    • EPPOrgCheckResult

      public EPPOrgCheckResult(String aOrgId, String aReason)
      Constructor for EPPOrgCheckResult that is used for unavailable org identifiers providing the reason the org identifier is not available.
      Parameters:
      aOrgId - The org identifier
      aReason - Reason that the org identifier is not available.

    • EPPOrgCheckResult

      public EPPOrgCheckResult(String aOrgId, String aReason, String aReasonLang)
      Constructor for EPPOrgCheckResult that is used for unavailable org identifiers providing the reason the org identifier is not available with the reason language.
      Parameters:
      aOrgId - The org identifier
      aReason - Reason that the org identifier is not available.
      aReasonLang - Reason language for reason value.

  • Method Details

    • getOrgId

      public String getOrgId()
      Gets the org identifier.
      Returns:
      The org identifier if defined;null otherwise.

    • setOrgId

      public void setOrgId(String aOrgId)
      Sets the org identifier.
      Parameters:
      aOrgId - The org identifier

    • isAvailable

      public boolean isAvailable()
      Is the org identifier available?
      Returns:
      true if the org identifier is available; false otherwise.

    • setAvailable

      public void setAvailable(boolean aAvailable)
      Sets the org identifier is available.
      Parameters:
      aAvailable - true if the org identifier is available; false otherwise.

    • hasReason

      public boolean hasReason()
      Is the reason defined?
      Returns:
      true if the reason is defined; false otherwise.

    • getReason

      public String getReason()
      Gets the reason that the org identifier is not available.
      Returns:
      Reason that the org identifier is not available if defined; null otherwise.

    • setReason

      public void setReason(String aReason)
      Sets the reason that the org identifier is not available.
      Parameters:
      aReason - Reason that the org identifier is not available. Set to null to clear the reason.

    • hasReasonLang

      public boolean hasReasonLang()
      Is the reason language defined?
      Returns:
      true if the reason language is defined; false otherwise.

    • getReasonLang

      public String getReasonLang()
      Gets the reason language value.
      Returns:
      Reason language if defined; null otherwise.

    • setReasonLang

      public void setReasonLang(String aReasonLang)
      Sets the reason language value.
      Parameters:
      aReasonLang - Reason language for reason value.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPOrgCheckResult

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • clone

      public Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPOrgCheckResult
      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.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPOrgCheckResult with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false 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.