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 |
DEFAULT_SCHEDULE_TZ
The default batch job schedule time zone.
|
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,
java.lang.String aSchedule)
EPPRegistryBatchJob constructor that takes all required
attributes. |
EPPRegistryBatchJob(java.lang.String aName,
java.lang.String aSchedule,
java.lang.String aDescription)
EPPRegistryBatchJob constructor that takes all attributes. |
EPPRegistryBatchJob(java.lang.String aName,
java.lang.String aSchedule,
java.lang.String aDescription,
java.lang.String aScheduleTimeZone)
EPPRegistryBatchJob constructor that takes all attributes. |
Modifier and Type | Method and Description |
---|---|
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.lang.String |
getSchedule()
Gets the execution schedule for the batch job using cron format.
|
java.lang.String |
getScheduleTimeZone()
Gets the schedule time zone
|
boolean |
hasDescription()
Is the description defined?
|
boolean |
hasName()
Is the name 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 |
setSchedule(java.lang.String aSchedule)
Sets the execution schedule for the batch job using cron format.
|
void |
setScheduleTimeZone(java.lang.String aScheduleTimeZone)
Sets the schedule time zone
|
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 DEFAULT_SCHEDULE_TZ
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 aSchedule)
EPPRegistryBatchJob
constructor that takes all required
attributes.aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedule
- Execution schedule for the batch job based on the cron schedule
format.public EPPRegistryBatchJob(java.lang.String aName, java.lang.String aSchedule, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that takes all attributes.aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedule
- Execution schedule for the batch job based on the cron schedule
format.aDescription
- OPTIONAL free-form description of batch job, like
"Auto Renew Batch" or "Pending Delete Batch".. Set to
null
if undefined.public EPPRegistryBatchJob(java.lang.String aName, java.lang.String aSchedule, java.lang.String aDescription, java.lang.String aScheduleTimeZone)
EPPRegistryBatchJob
constructor that takes all attributes.aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedule
- Execution schedule for the batch job based on the cron schedule
format.aDescription
- OPTIONAL free-form description of batch job, like
"Auto Renew Batch" or "Pending Delete Batch".. Set to
null
if undefined.aScheduleTimeZone
- the schedule time zone to set. If set to null
the
default of DEFAULT_SCHEDULE_TZ
will be used.public 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 java.lang.String getSchedule()
null
otherwise.public void setSchedule(java.lang.String aSchedule)
aSchedule
- the schedule to setpublic java.lang.String getScheduleTimeZone()
public void setScheduleTimeZone(java.lang.String aScheduleTimeZone)
aScheduleTimeZone
- the schedule time zone to set. If set to null
the
default of DEFAULT_SCHEDULE_TZ
will be used.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.