Package com.verisign.epp.codec.domain

Class EPPDomainPeriod

java.lang.Object
com.verisign.epp.codec.domain.EPPDomainPeriod
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPDomainPeriod extends Object implements EPPCodecComponent
Represents a domain Period. A domain name object MAY have a specified validity period. If server policy supports domain object validity periods, the validity period is defined when a domain object is created, and it MAY be extended by the EPP <renew> or <transfer> commands. As a matter of server policy, this specification does not define actions to be taken upon expiration of a domain object's validity period.

Validity periods are measured in years or months with the appropriate units specified using the unit attribute. Valid values for the unit attribute are y for years and m for months.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPDomainPeriod.
    static final String
    ELM_NAME
    XML Element Name of EPPDomainPeriod root element.
    static final String
    PERIOD_UNIT_MONTH
    Period in Unit Month
    static final String
    PERIOD_UNIT_YEAR
    Period in Unit Year

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPDomainPeriod()
    EPPDomainPeriod default constructor.
    EPPDomainPeriod(int aPeriod)
    EPPDomainPeriod constructor that takes the domain period (in unit of year) as an argument
    EPPDomainPeriod(String aPUnit, int aPeriod)
    EPPDomainPeriod constructor that takes the domain period and period unit as an arguments

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPDomainPeriod.
    void
    decode(Element aElement)
    Decode the EPPDomainPeriod attributes from the aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPDomainPeriod instance.
    boolean
    equals(Object aObject)
    implements a deep EPPDomainPeriod compare.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    int
    getPeriod()
    Get domain period.
    String
    getPUnit()
    Get domain period unit.
    boolean
    isPeriodUnspec()
    Test whether the period has been specfied: true is unspecified and false is specified.
    void
    setPeriod(int newPeriod)
    Set domain period.
    void
    setPUnit(String newPUnit)
    Set domain period of un.
    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

    • EPPDomainPeriod

      public EPPDomainPeriod()
      EPPDomainPeriod default constructor. The period is initialized to unspecified. The period must be set before invoking encode.

    • EPPDomainPeriod

      public EPPDomainPeriod(int aPeriod)
      EPPDomainPeriod constructor that takes the domain period (in unit of year) as an argument
      Parameters:
      aPeriod - int

    • EPPDomainPeriod

      public EPPDomainPeriod(String aPUnit, int aPeriod)
      EPPDomainPeriod constructor that takes the domain period and period unit as an arguments
      Parameters:
      aPUnit - String
      aPeriod - int

  • Method Details

    • clone

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

    • decode

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

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPDomainPeriod compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPDomainPeriod instance to compare with
      Returns:
      true if equal; false otherwise.

    • getPeriod

      public int getPeriod()
      Get domain period.
      Returns:
      int

    • getPUnit

      public String getPUnit()
      Get domain period unit.
      Returns:
      String

    • isPeriodUnspec

      public boolean isPeriodUnspec()
      Test whether the period has been specfied: true is unspecified and false is specified.
      Returns:
      boolean

    • setPeriod

      public void setPeriod(int newPeriod) throws EPPCodecException
      Set domain period.
      Parameters:
      newPeriod - int
      Throws:
      EPPCodecException - DOCUMENT ME!

    • setPUnit

      public void setPUnit(String newPUnit)
      Set domain period of un. Creation date: (5/30/01 11:36:52 AM)
      Parameters:
      newPUnit - java.lang.String

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