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

Class EPPRegistryBatchJob

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryBatchJob
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryBatchJob extends Object implements EPPCodecComponent
EPPRegistryBatchJob contains the information for an individual batch job.
See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryBatchJob

      public EPPRegistryBatchJob()
      Default constructor for EPPRegistryBatchJob.

    • EPPRegistryBatchJob

      public EPPRegistryBatchJob(String aName, String aDescription)
      EPPRegistryBatchJob constructor that the name and the optional description. At least one schedule must be set. individual schedule.
      Parameters:
      aName - Name of the batch job, like "autoRenew" or "pendingDelete".
      aDescription - Description of the batch job

    • EPPRegistryBatchJob

      public EPPRegistryBatchJob(String aName, EPPRegistryBatchSchedule aSchedule)
      EPPRegistryBatchJob constructor that the required name and an individual schedule.
      Parameters:
      aName - Name of the batch job, like "autoRenew" or "pendingDelete".
      aSchedule - An individual batch schedule using XML schema "time" type format

    • EPPRegistryBatchJob

      public EPPRegistryBatchJob(String aName, EPPRegistryBatchSchedule aSchedule, String aDescription)
      EPPRegistryBatchJob constructor that the required name, an individual schedule, along with an optional description.
      Parameters:
      aName - Name of the batch job, like "autoRenew" or "pendingDelete".
      aSchedule - An individual batch schedule using the XML schema "time" type format
      aDescription - Description of the batch job

    • EPPRegistryBatchJob

      public EPPRegistryBatchJob(String aName, List<EPPRegistryBatchSchedule> aSchedules, String aDescription)
      EPPRegistryBatchJob constructor that the required name, a list of schedules, along with an optional description.
      Parameters:
      aName - Name of the batch job, like "autoRenew" or "pendingDelete".
      aSchedules - A list of schedules with each schedule using the XML schema "time" type format
      aDescription - Description of the batch job

  • Method Details

    • encode

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

    • decode

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

    • clone

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

    • equals

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

    • hasName

      public boolean hasName()
      Is the name defined?
      Returns:
      true if the name is defined; false otherwise.

    • getName

      public String getName()
      Gets the name of the batch job, like "autoRenew" or "pendingDelete".
      Returns:
      Name of the batch job if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the name of the batch job, like "autoRenew" or "pendingDelete".
      Parameters:
      aName - Name of the batch job

    • hasDescription

      public boolean hasDescription()
      Is the description defined?
      Returns:
      true if the description is defined; false otherwise.

    • getDescription

      public String getDescription()
      Gets the OPTIONAL free-form description of batch job, like "Auto Renew Batch" or "Pending Delete Batch".
      Returns:
      batch job description if defined; null otherwise.

    • setDescription

      public void setDescription(String aDescription)
      Sets the OPTIONAL free-form description of batch job, like "Auto Renew Batch" or "Pending Delete Batch".
      Parameters:
      aDescription - the description to set

    • hasSchedules

      public boolean hasSchedules()
      Is the schedules defined?
      Returns:
      true if the schedules is defined; false otherwise.

    • getSchedules

      public List<EPPRegistryBatchSchedule> getSchedules()
      Gets the List of EPPRegistryBatchSchedule instances containing the batch job schedules.
      Returns:
      List of EPPRegistryBatchSchedule instances if defined; null otherwise.

    • setSchedules

      public void setSchedules(List<EPPRegistryBatchSchedule> aSchedules)
      Sets the List of EPPRegistryBatchSchedule instances containing the batch job schedules.
      Parameters:
      aSchedules - List of EPPRegistryBatchSchedule instances

    • addSchedule

      public void addSchedule(EPPRegistryBatchSchedule aSchedule)
      Adds a schedule to the list of batch job schedules.
      Parameters:
      aSchedule - Schedule to add to the list of batch job schedules

    • getNamespace

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