Package com.verisign.epp.codec.registry.v02

Class EPPRegistryCheckResult

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryCheckResult
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryCheckResult extends Object implements EPPCodecComponent
EPPRegistryCheckResult provides the result of checking the availability of an individual zone.
See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryCheckResult

      public EPPRegistryCheckResult()
      Creates a new EPPRegistryCheckResult object with an empty zone name and availability set to true. The Zone name must be set via setName(String) prior to calling encode(Document).

    • EPPRegistryCheckResult

      public EPPRegistryCheckResult(String aName, Boolean aAvailable)
      Creates a new EPPRegistryCheckResult object with a defined aLabel zone name and available value.
      Parameters:
      aName - aLabel zone name
      aAvailable - true if available; false otherwise.

    • EPPRegistryCheckResult

      public EPPRegistryCheckResult(EPPRegistryZoneName aName, Boolean aAvailable)
      Creates a new EPPRegistryCheckResult object with a defined zone name and available value.
      Parameters:
      aName - Zone name
      aAvailable - true if available; false otherwise.

    • EPPRegistryCheckResult

      public EPPRegistryCheckResult(String aName, Boolean aAvailable, String aReason)
      Creates a new EPPRegistryCheckResult object with a defined aLabel zone name, available value, and reason.
      Parameters:
      aName - aLabel zone name
      aAvailable - Should be set to false for this constructor.
      aReason - Reason Unavailable reason using the default language of VALUE_LANG.

    • EPPRegistryCheckResult

      public EPPRegistryCheckResult(EPPRegistryZoneName aName, Boolean aAvailable, String aReason)
      Creates a new EPPRegistryCheckResult object with a defined zone name, available value, and reason.
      Parameters:
      aName - Zone name
      aAvailable - Should be set to false for this constructor.
      aReason - Reason Unavailable reason using the default language of VALUE_LANG.

  • Method Details

    • encode

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

    • decode

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

    • clone

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPRegistryCheckResult with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if this object is the same as the aObject argument; false otherwise

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

    • getLanguage

      public String getLanguage()
      Gets the unavailable reason language with the default value of VALUE_LANG.
      Returns:
      Unavailable reason langauge with the default value of VALUE_LANG.

    • setLanguage

      public void setLanguage(String aLanguage)
      Sets the unavailable reason language with the default value of VALUE_LANG.
      Parameters:
      aLanguage - Language of the unavailable reason set with setReason(String).

    • getName

      public EPPRegistryZoneName getName()
      Gets the zone name.
      Returns:
      Zone name if set; null otherwise.

    • setName

      public void setName(EPPRegistryZoneName aName)
      Sets the zone name
      Parameters:
      aName - Zone name

    • setName

      public void setName(String aName)
      Sets the aLabel zone name
      Parameters:
      aName - aLabel zone name

    • isAvailable

      public Boolean isAvailable()
      Gets the zone available.
      Returns:
      true if available; false otherwise.

    • setAvailable

      public void setAvailable(Boolean aAvailable)
      Sets the zone available.
      Parameters:
      aAvailable - true if available; false otherwise.

    • getReason

      public String getReason()
      Gets the unavailable reason. This value should be null if isAvailable() is true.
      Returns:
      The unavailable reason if set; null otherwise.

    • setReason

      public void setReason(String aReason)
      Sets the unavailable reason. This value should be null if isAvailable() is true.
      Parameters:
      aReason - Unavailable reason. Set to null if zone is available.

    • getNamespace

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