Package com.verisign.epp.codec.defReg

Class EPPDefRegCheckResult

java.lang.Object
com.verisign.epp.codec.defReg.EPPDefRegCheckResult
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPDefRegCheckResult extends Object implements EPPCodecComponent
EPPDomainCheckResult represents the result of an individual defReg name ping. The attributes of EPPDomainCheckResult include the defReg name and attributes namely level which is either "premium" or "standard" and boolean value indicating if the defReg name is already available. defReg reason must be set before invoking encode if the available flag is set to false.
See Also:

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPDefRegCheckResult.
    void
    decode(Element aElement)
    Decode the EPPDefRegCheckResult attributes from the aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPDefRegCheckResult instance.
    boolean
    equals(Object aObject)
    Compare an instance of EPPDefRegPingResp with this instance.
    String
    getDefRegReason()
    Gets defReg reason.
    String
    getLanguage()
    Sets defReg reason to check.
    String
    getLevel()
    Gets the defReg level associated with the result.
    String
    getName()
    Gets the defReg name associated with the result.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    boolean
    isAvailable()
    Gets if the defReg associated with EPPDomainCheckResult is available.
    void
    setDefRegReason(String aReason)
    Sets defReg reason.
    void
    setIsAvailable(boolean aIsAvailable)
    Sets if the defReg associated with EPPDefRegCheckResult is available.
    void
    setLanguage(String aLang)
    Sets language attribute.
    void
    setLevel(String aLevel)
    Sets the defReg level associated with the result.
    void
    setName(String aName)
    Sets the defReg name associated with the result.
    String
    toString()
    Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
    void
    validate()
    Validate the state of the EPPDefRegCreateCmd instance.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • EPPDefRegCheckResult

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

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

      The name must be set before invoking encode.

    • EPPDefRegCheckResult

      public EPPDefRegCheckResult(String aName, String aLevel, boolean aIsAvailable)
      Constructor for EPPDefRegCheckResult that includes the defReg name and the is available flag.
      Parameters:
      aName - DefReg name associated with result
      aLevel - DefReg level associated with result, which should be either EPPDefRegName.LEVEL_STANDARD or EPPDefRegName.LEVEL_STANDARD.
      aIsAvailable - Is the defReg name available?

  • Method Details

    • clone

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

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPDefRegCheckResult attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPDefRegCheckResult 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 EPPDefRegCheckResult 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 EPPDefRegCheckResult instance.
      Throws:
      EPPEncodeException - Unable to encode EPPDefRegCheckResult instance.

    • equals

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

    • getDefRegReason

      public String getDefRegReason()
      Gets defReg reason.
      Returns:
      String of defReg reason.

    • getLanguage

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

    • getLevel

      public String getLevel()
      Gets the defReg level associated with the result. The level should be either EPPDefRegName.LEVEL_STANDARD or EPPDefRegName.LEVEL_STANDARD,
      Returns:
      DefReg level associated with the result if defined; null otherwise.

    • getName

      public String getName()
      Gets the defReg name associated with the result.
      Returns:
      DefReg name associated with the result if defined; null otherwise.

    • isAvailable

      public boolean isAvailable()
      Gets if the defReg associated with EPPDomainCheckResult is available.
      Returns:
      Is the defReg available?

    • setDefRegReason

      public void setDefRegReason(String aReason)
      Sets defReg reason.
      Parameters:
      aReason - DefReg Reason.

    • setIsAvailable

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

    • setLanguage

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

    • setLevel

      public void setLevel(String aLevel)
      Sets the defReg level associated with the result.
      Parameters:
      aLevel - DefReg Level associated with the result, which should be either EPPDefRegName.LEVEL_STANDARD or EPPDefRegName.LEVEL_STANDARD.

    • setName

      public void setName(String aName)
      Sets the defReg name associated with the result.
      Parameters:
      aName - DefReg 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.

    • validate

      public void validate() throws EPPEncodeException
      Validate the state of the EPPDefRegCreateCmd instance. A valid state means that all of the required attributes have been set. If validateState returns without an exception, the state is valid. If the state is not valid, the EPPCodecException will contain a description of the error. throws EPPCodecException State error. This will contain the name of the attribute that is not valid.
      Throws:
      EPPEncodeException - DOCUMENT ME!

    • getNamespace

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