public class EPPRegistryBatchJob extends java.lang.Object implements EPPCodecComponent
EPPRegistryBatchJob
contains the information for an individual batch
job.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPRegistryBatchJob . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPRegistryBatchJob . |
Constructor and Description |
---|
EPPRegistryBatchJob()
Default constructor for
EPPRegistryBatchJob . |
EPPRegistryBatchJob(java.lang.String aName,
EPPRegistryBatchSchedule aSchedule)
EPPRegistryBatchJob constructor that the required name and an
individual schedule. |
EPPRegistryBatchJob(java.lang.String aName,
EPPRegistryBatchSchedule aSchedule,
java.lang.String aDescription)
EPPRegistryBatchJob constructor that the required name, an
individual schedule, along with an optional description. |
EPPRegistryBatchJob(java.lang.String aName,
java.util.List<EPPRegistryBatchSchedule> aSchedules,
java.lang.String aDescription)
EPPRegistryBatchJob constructor that the required name, a list of
schedules, along with an optional description. |
EPPRegistryBatchJob(java.lang.String aName,
java.lang.String aDescription)
EPPRegistryBatchJob constructor that the name and the optional
description. |
Modifier and Type | Method and Description |
---|---|
void |
addSchedule(EPPRegistryBatchSchedule aSchedule)
Adds a schedule to the list of batch job schedules.
|
java.lang.Object |
clone()
Clone
EPPRegistryBatchJob . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPRegistryBatchJob attributes from the aElement DOM
Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the
EPPRegistryBatchJob instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPRegistryBatchJob compare. |
java.lang.String |
getDescription()
Gets the OPTIONAL free-form description of batch job, like
"Auto Renew Batch" or "Pending Delete Batch".
|
java.lang.String |
getName()
Gets the name of the batch job, like "autoRenew" or "pendingDelete".
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.util.List<EPPRegistryBatchSchedule> |
getSchedules()
Gets the
List of EPPRegistryBatchSchedule instances
containing the batch job schedules. |
boolean |
hasDescription()
Is the description defined?
|
boolean |
hasName()
Is the name defined?
|
boolean |
hasSchedules()
Is the schedules defined?
|
void |
setDescription(java.lang.String aDescription)
Sets the OPTIONAL free-form description of batch job, like
"Auto Renew Batch" or "Pending Delete Batch".
|
void |
setName(java.lang.String aName)
Sets the name of the batch job, like "autoRenew" or "pendingDelete".
|
void |
setSchedules(java.util.List<EPPRegistryBatchSchedule> aSchedules)
Sets the
List of EPPRegistryBatchSchedule instances
containing the batch job schedules. |
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String ELM_LOCALNAME
EPPRegistryBatchJob
.public static final java.lang.String ELM_NAME
EPPRegistryBatchJob
.public EPPRegistryBatchJob()
EPPRegistryBatchJob
.public EPPRegistryBatchJob(java.lang.String aName, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the name and the optional
description. At least one schedule must be set. individual schedule.aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aDescription
- Description of the batch jobpublic EPPRegistryBatchJob(java.lang.String aName, EPPRegistryBatchSchedule aSchedule)
EPPRegistryBatchJob
constructor that the required name and an
individual schedule.aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedule
- An individual batch schedule using XML schema "time" type formatpublic EPPRegistryBatchJob(java.lang.String aName, EPPRegistryBatchSchedule aSchedule, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the required name, an
individual schedule, along with an optional description.aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedule
- An individual batch schedule using the XML schema "time" type
formataDescription
- Description of the batch jobpublic EPPRegistryBatchJob(java.lang.String aName, java.util.List<EPPRegistryBatchSchedule> aSchedules, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the required name, a list of
schedules, along with an optional description.aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedules
- A list of schedules with each schedule using the XML schema
"time" type formataDescription
- Description of the batch jobpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRegistryBatchJob
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPRegistryBatchJob
instance.EPPEncodeException
- - Unable to encode EPPRegistryBatchJob
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRegistryBatchJob
attributes from the aElement DOM
Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPRegistryBatchJob
from.EPPDecodeException
- Unable to decode aElementpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRegistryBatchJob
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPRegistryBatchJob
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic boolean equals(java.lang.Object aObject)
EPPRegistryBatchJob
compare.equals
in class java.lang.Object
aObject
- EPPRegistryBatchJob
instance to compare withtrue
if this object is the same as the aObject argument;
false
otherwisepublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.toString
in class java.lang.Object
String
if successful; ERROR
otherwise.public boolean hasName()
true
if the name is defined; false
otherwise.public java.lang.String getName()
null
otherwise.public void setName(java.lang.String aName)
aName
- Name of the batch jobpublic boolean hasDescription()
true
if the description is defined; false
otherwise.public java.lang.String getDescription()
null
otherwise.public void setDescription(java.lang.String aDescription)
aDescription
- the description to setpublic boolean hasSchedules()
true
if the schedules is defined; false
otherwise.public java.util.List<EPPRegistryBatchSchedule> getSchedules()
List
of EPPRegistryBatchSchedule
instances
containing the batch job schedules.List
of EPPRegistryBatchSchedule
instances if
defined; null
otherwise.public void setSchedules(java.util.List<EPPRegistryBatchSchedule> aSchedules)
List
of EPPRegistryBatchSchedule
instances
containing the batch job schedules.aSchedules
- List
of EPPRegistryBatchSchedule
instancespublic void addSchedule(EPPRegistryBatchSchedule aSchedule)
aSchedule
- Schedule to add to the list of batch job schedulespublic java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.