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

Class EPPRegistryZoneSummary

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryZoneSummary
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryZoneSummary extends Object implements EPPCodecComponent
Represents the summary info of a zone object. Zone summary info of all supported zones is returned is a list when the server receives an <info> command, with a <registry:all> element in it.

The zone summary info element contains:
See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryZoneSummary

      public EPPRegistryZoneSummary()
      Default constructor. Attributes are set to:
      • name - null
      • createDate - null
      • updateDate - null
      Use setName(EPPRegistryZoneName) and setCreateDate(Date) before calling encode(Document)

    • EPPRegistryZoneSummary

      public EPPRegistryZoneSummary(String aName, boolean aAccessible, Date aCreateDate)
      Construct EPPRegistryZoneSummary with aLabel name and create date. updateDate is set to null.
      Parameters:
      aName - fully qualified aLabel name of zone object
      aAccessible - Indicates whether the zone is accessible with true or available with false.
      aCreateDate - creation date of zone object

    • EPPRegistryZoneSummary

      public EPPRegistryZoneSummary(EPPRegistryZoneName aName, boolean aAccessible, Date aCreateDate)
      Construct EPPRegistryZoneSummary with name and create date. updateDate is set to null.
      Parameters:
      aName - fully qualified name of zone object
      aAccessible - Indicates whether the zone is accessible with true or available with false.
      aCreateDate - creation date of zone object

    • EPPRegistryZoneSummary

      public EPPRegistryZoneSummary(String aName, boolean aAccessible, Date aCreateDate, Date aUpdateDate)
      Construct EPPRegistryZoneSummary with aLabel name, create date and last update date.
      Parameters:
      aName - fully qualified aLabel name of zone object
      aAccessible - Indicates whether the zone is accessible with true or available with false.
      aCreateDate - creation date of zone object
      aUpdateDate - date of last update

    • EPPRegistryZoneSummary

      public EPPRegistryZoneSummary(EPPRegistryZoneName aName, boolean aAccessible, Date aCreateDate, Date aUpdateDate)
      Construct EPPRegistryZoneSummary with name, create date and last update date.
      Parameters:
      aName - fully qualified name of zone object
      aAccessible - Indicates whether the zone is accessible with true or available with false.
      aCreateDate - creation date of zone object
      aUpdateDate - date of last update

  • Method Details

    • encode

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

    • decode

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

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRegistryZoneSummary compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryZoneSummary instance to compare with
      Returns:
      true if this object is the same as the aObject argument; false otherwise

    • clone

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

    • 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

    • getCreateDate

      public Date getCreateDate()
      Get creation date of zone object.
      Returns:
      creation date of zone object

    • setCreateDate

      public void setCreateDate(Date createDate)
      Set creation date of zone object.
      Parameters:
      createDate - creation date of zone object

    • getUpdateDate

      public Date getUpdateDate()
      Get last update date of zone object.
      Returns:
      last update date of zone object

    • setUpdateDate

      public void setUpdateDate(Date updateDate)
      Set last update date of zone object.
      Parameters:
      updateDate - last update date of zone object

    • isAccessible

      public boolean isAccessible()
      Is the zone accessible to the client?
      Returns:
      true if the zone is accessible; false otherwise.

    • setAccessible

      public void setAccessible(boolean aAccessible)
      Sets if the zone is access to the client.
      Parameters:
      aAccessible - true if the zone is accessible; 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.