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

Class EPPRegistryBatchSchedule

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryBatchSchedule
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryBatchSchedule extends Object implements EPPCodecComponent
EPPRegistryBatchSchedule defines a batch schedule that uses the <registry:schedule> element, with the required "frequency" attribute that defines the frequency of execution. The "frequency" attribute has the possible values of "daily", "weekly", and "monthy". The time zone is defined using the XML schema "time" type conventions of UTC and offsets from UTC, or using the OPTIONAL "tz" attribute that defines the named time zone. For example, the named Eastern time zone can be specified using the setting "tz=EST5EDT".
See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryBatchSchedule

      public EPPRegistryBatchSchedule()
      Default constructor. Must call setFrequency(Frequency) and setTime(String) before calling the encode(org.w3c.dom.Document) method.

    • EPPRegistryBatchSchedule

      public EPPRegistryBatchSchedule(EPPRegistryBatchSchedule.Frequency aFrequency, String aTime)
      Construct an instance of EPPRegistryBatchSchedule with the required frequency and time.
      Parameters:
      aFrequency - The frequency of the schedule
      aTime - The time of the schedule following the XML schema "time" type format

    • EPPRegistryBatchSchedule

      public EPPRegistryBatchSchedule(String aTime, String aTimeZone)
      Construct an instance of EPPRegistryBatchSchedule that is used for a daily schedule.
      Parameters:
      aTime - The time of the schedule following the XML schema "time" type format
      aTimeZone - The named time zone of the time, represented by the aTime parameter. An example of a named time zone is "EST5EDT". Set to null if undefined.

    • EPPRegistryBatchSchedule

      public EPPRegistryBatchSchedule(String aTime, EPPRegistryBatchSchedule.DayOfWeek aDayOfWeek, String aTimeZone)
      Construct an instance of EPPRegistryBatchSchedule that is used for a day of week schedule.
      Parameters:
      aTime - The time of the schedule following the XML schema "time" type format
      aDayOfWeek - A day of the week
      aTimeZone - Optional named time zone of the time, represented by the aTime parameter. An example of a named time zone is "EST5EDT". Set to null if undefined.

    • EPPRegistryBatchSchedule

      public EPPRegistryBatchSchedule(String aTime, Integer aDayOfMonth, String aTimeZone)
      Construct an instance of EPPRegistryBatchSchedule that is used for a day of month schedule.
      Parameters:
      aTime - The time of the schedule following the XML schema "time" type format
      aDayOfMonth - The day of month in the range of 1 - 31. Execution will not occur in the current month if the aDayOfMonth value is out-of-range for the current month (e.g, 29 - 31).
      aTimeZone - Optional named time zone of the time, represented by the aTime parameter. An example of a named time zone is "EST5EDT". Set to null if undefined.

  • Method Details

    • encode

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

    • decode

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

    • clone

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

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRegistryBatchSchedule compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryBatchSchedule instance 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.

    • getFrequency

      public EPPRegistryBatchSchedule.Frequency getFrequency()
      Gets the schedule execution frequency.
      Returns:
      The schedule execution frequency if defined; null otherwise.

    • setFrequency

      public void setFrequency(EPPRegistryBatchSchedule.Frequency aFrequency)
      Sets the schedule execution frequency.
      Parameters:
      aFrequency - The schedule execution frequency

    • getTime

      public String getTime()
      Gets the schedule execution time using the XML schema "time" type format. Examples include "14:00:00" for a time without a time zone offset, "07:00:00-05:00" for a time with a 5 hour offset from UTC or EST time zone, and "17:00:00Z" for 5 PM UTC.
      Returns:
      The schedule execution time if defined; null otherwise.

    • setTime

      public void setTime(String aTime)
      Sets the schedule execution time using the XML schema "time" type format. Examples include "14:00:00" for a time without a time zone offset, "07:00:00-05:00" for a time with a 5 hour offset from UTC or EST time zone, and "17:00:00Z" for 5 PM UTC.
      Parameters:
      aTime - The schedule execution time

    • hasTimeZone

      public boolean hasTimeZone()
      Is the schedule execution named time zone defined?
      Returns:
      true if the schedule execution named time zone is defined; false otherwise.

    • getTimeZone

      public String getTimeZone()
      Gets the optional schedule execution named time zone, such as "EST5EDT".
      Returns:
      The schedule execution named time zone if defined; null otherwise.

    • setTimeZone

      public void setTimeZone(String aTimeZone)
      Sets the optional schedule execution named time zone, such as "EST5EDT".
      Parameters:
      aTimeZone - The schedule execution named time zone

    • hasDayOfWeek

      public boolean hasDayOfWeek()
      Is the day of week defined?
      Returns:
      true if the day of week defined; false otherwise.

    • getDayOfWeek

      public EPPRegistryBatchSchedule.DayOfWeek getDayOfWeek()
      Gets the optional day of week.
      Returns:
      The day of week if defined; null otherwise.

    • setDayOfWeek

      public void setDayOfWeek(EPPRegistryBatchSchedule.DayOfWeek aDayOfWeek)
      Sets the optional day of week.
      Parameters:
      aDayOfWeek - The day of week. Set to null if undefined.

    • hasDayOfMonth

      public boolean hasDayOfMonth()
      Is the day of month defined?
      Returns:
      true if the day of month defined; false otherwise.

    • getDayOfMonth

      public Integer getDayOfMonth()
      Gets the optional day of month.
      Returns:
      The day of month if defined; null otherwise.

    • setDayOfMonth

      public void setDayOfMonth(Integer aDayOfMonth)
      Sets the optional day of month.
      Parameters:
      aDayOfMonth - The day of month. Set to null if undefined.

    • getNamespace

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