public class EPPRegistryBatchSchedule extends java.lang.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".EPPRegistryDomain
,
Serialized FormModifier and Type | Class and Description |
---|---|
static class |
EPPRegistryBatchSchedule.DayOfWeek
Possible values for the
dayOfWeek attribute. |
static class |
EPPRegistryBatchSchedule.Frequency
Possible values for the
frequency attribute. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_DAY_OF_MONTH
XML attribute name for the
dayOfMonth attribute. |
static java.lang.String |
ATTR_DAY_OF_WEEK
XML attribute name for the
dayOfWeek attribute. |
static java.lang.String |
ATTR_FREQUENCY
XML attribute name for the
frequency attribute. |
static java.lang.String |
ATTR_TZ
XML attribute name for the
tz attribute. |
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPRegistryBatchSchedule . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPRegistryBatchSchedule . |
Constructor and Description |
---|
EPPRegistryBatchSchedule()
Default constructor.
|
EPPRegistryBatchSchedule(EPPRegistryBatchSchedule.Frequency aFrequency,
java.lang.String aTime)
Construct an instance of
EPPRegistryBatchSchedule with the
required frequency and time. |
EPPRegistryBatchSchedule(java.lang.String aTime,
EPPRegistryBatchSchedule.DayOfWeek aDayOfWeek,
java.lang.String aTimeZone)
Construct an instance of
EPPRegistryBatchSchedule that is used for
a day of week schedule. |
EPPRegistryBatchSchedule(java.lang.String aTime,
java.lang.Integer aDayOfMonth,
java.lang.String aTimeZone)
Construct an instance of
EPPRegistryBatchSchedule that is used for
a day of month schedule. |
EPPRegistryBatchSchedule(java.lang.String aTime,
java.lang.String aTimeZone)
Construct an instance of
EPPRegistryBatchSchedule that is used for
a daily schedule. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPRegistryBatchSchedule . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPRegistryBatchSchedule 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
EPPRegistryDomain instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPRegistryBatchSchedule compare. |
java.lang.Integer |
getDayOfMonth()
Gets the optional day of month.
|
EPPRegistryBatchSchedule.DayOfWeek |
getDayOfWeek()
Gets the optional day of week.
|
EPPRegistryBatchSchedule.Frequency |
getFrequency()
Gets the schedule execution frequency.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getTime()
Gets the schedule execution time using the XML schema "time" type format.
|
java.lang.String |
getTimeZone()
Gets the optional schedule execution named time zone, such as "EST5EDT".
|
boolean |
hasDayOfMonth()
Is the day of month defined?
|
boolean |
hasDayOfWeek()
Is the day of week defined?
|
boolean |
hasTimeZone()
Is the schedule execution named time zone defined?
|
void |
setDayOfMonth(java.lang.Integer aDayOfMonth)
Sets the optional day of month.
|
void |
setDayOfWeek(EPPRegistryBatchSchedule.DayOfWeek aDayOfWeek)
Sets the optional day of week.
|
void |
setFrequency(EPPRegistryBatchSchedule.Frequency aFrequency)
Sets the schedule execution frequency.
|
void |
setTime(java.lang.String aTime)
Sets the schedule execution time using the XML schema "time" type format.
|
void |
setTimeZone(java.lang.String aTimeZone)
Sets the optional schedule execution named time zone, such as "EST5EDT".
|
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
EPPRegistryBatchSchedule
.public static final java.lang.String ELM_NAME
EPPRegistryBatchSchedule
.public static final java.lang.String ATTR_FREQUENCY
frequency
attribute.public static final java.lang.String ATTR_TZ
tz
attribute.public static final java.lang.String ATTR_DAY_OF_WEEK
dayOfWeek
attribute.public static final java.lang.String ATTR_DAY_OF_MONTH
dayOfMonth
attribute.public EPPRegistryBatchSchedule()
setFrequency(Frequency)
and
setTime(String)
before calling the
encode(org.w3c.dom.Document)
method.public EPPRegistryBatchSchedule(EPPRegistryBatchSchedule.Frequency aFrequency, java.lang.String aTime)
EPPRegistryBatchSchedule
with the
required frequency and time.aFrequency
- The frequency of the scheduleaTime
- The time of the schedule following the XML schema "time" type
formatpublic EPPRegistryBatchSchedule(java.lang.String aTime, java.lang.String aTimeZone)
EPPRegistryBatchSchedule
that is used for
a daily schedule.aTime
- The time of the schedule following the XML schema "time" type
formataTimeZone
- 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.public EPPRegistryBatchSchedule(java.lang.String aTime, EPPRegistryBatchSchedule.DayOfWeek aDayOfWeek, java.lang.String aTimeZone)
EPPRegistryBatchSchedule
that is used for
a day of week schedule.aTime
- The time of the schedule following the XML schema "time" type
formataDayOfWeek
- A day of the weekaTimeZone
- 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.public EPPRegistryBatchSchedule(java.lang.String aTime, java.lang.Integer aDayOfMonth, java.lang.String aTimeZone)
EPPRegistryBatchSchedule
that is used for
a day of month schedule.aTime
- The time of the schedule following the XML schema "time" type
formataDayOfMonth
- 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.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRegistryDomain
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPRegistryDomain
instance.EPPEncodeException
- - Unable to encode EPPRegistryBatchSchedule
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRegistryBatchSchedule
attributes from the aElement
DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPRegistryBatchSchedule
from.EPPDecodeException
- Unable to decode aElementpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRegistryBatchSchedule
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPRegistryBatchSchedule
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic boolean equals(java.lang.Object aObject)
EPPRegistryBatchSchedule
compare.equals
in class java.lang.Object
aObject
- EPPRegistryBatchSchedule
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 EPPRegistryBatchSchedule.Frequency getFrequency()
null
otherwise.public void setFrequency(EPPRegistryBatchSchedule.Frequency aFrequency)
aFrequency
- The schedule execution frequencypublic java.lang.String getTime()
null
otherwise.public void setTime(java.lang.String aTime)
aTime
- The schedule execution timepublic boolean hasTimeZone()
true
if the schedule execution named time zone is defined;
false
otherwise.public java.lang.String getTimeZone()
null
otherwise.public void setTimeZone(java.lang.String aTimeZone)
aTimeZone
- The schedule execution named time zonepublic boolean hasDayOfWeek()
true
if the day of week defined; false
otherwise.public EPPRegistryBatchSchedule.DayOfWeek getDayOfWeek()
null
otherwise.public void setDayOfWeek(EPPRegistryBatchSchedule.DayOfWeek aDayOfWeek)
aDayOfWeek
- The day of week. Set to null
if undefined.public boolean hasDayOfMonth()
true
if the day of month defined; false
otherwise.public java.lang.Integer getDayOfMonth()
null
otherwise.public void setDayOfMonth(java.lang.Integer aDayOfMonth)
aDayOfMonth
- The day of month. Set to null
if undefined.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.