com.cleo.lexicom.external

Interface ISchedule.Item.Calendar

Enclosing interface:

ISchedule.Item

public static interface ISchedule.Item.Calendar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ISchedule.Item.Calendar.Time

Method Summary

Modifier and Type	Method and Description
ISchedule.Item.Calendar.Time	addTime() Adds a new run time to the calendar
void	clearTimes() Clear all of the run times for this calendar
java.lang.String	getDate() Get the date for a ONE_TIME calendar period
java.lang.String	getDays() Get the list of named days for a WEEKLY calendar period.
java.lang.String	getDaysOfMonth() Get the set of numbered days for a MONTHLY calendar period.
java.lang.String	getMonths() Get the list of named months for a MONTHLY calendar period.
java.lang.String	getRecurrence() Get the recurring day setting for a MONTHLY calendar period.
java.lang.String	getRecurrentDay() Get the recurrent named day setting for a MONTHLY calendar period.
boolean	isRecurrent() Indicates whether there is a recurrent day setting for a MONTHLY calendar period.
java.util.List<ISchedule.Item.Calendar.Time>	listTimes() Get the list of run times for this calendar's scheduled days.
void	setDate(java.lang.String date) Set the date for a ONE_TIME calendar period
void	setDays(java.lang.String days) Set the list of named days for a WEEKLY calendar period.
void	setDaysOfMonth(java.lang.String daysOfMonth) Set the set of numbered days for a MONTHLY calendar period.
void	setDaysOfMonth(java.lang.String recurrence, java.lang.String day) Set the recurrence and named day for a MONTHLY calendar period.
void	setMonths(java.lang.String months) Set the list of named months for a MONTHLY calendar period.

Method Detail

getDays

java.lang.String getDays()

Get the list of named days for a WEEKLY calendar period. Day ranges are separated by hyphens (e.g. Su-Sa). Use two-letter day constants SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY. A week starts on SUNDAY, ends on SATURDAY.

Returns:

the list of named days for a WEEKLY calendar period

getMonths

java.lang.String getMonths()

Get the list of named months for a MONTHLY calendar period. Month ranges are separated by hyphens (e.g. Jan-Dec). Use three-letter month constants JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, and DECEMBER.

Returns:

the list of named months for a MONTHLY calendar period

listTimes

java.util.List<ISchedule.Item.Calendar.Time> listTimes()

Get the list of run times for this calendar's scheduled days. More than one run time can exist in a calendar as long as the run times do not overlap

Returns:

the list of run times for this calendar's scheduled days

getDaysOfMonth

java.lang.String getDaysOfMonth()

Get the set of numbered days for a MONTHLY calendar period. The scheduled days for a MONTHLY calendar period can be either a set of numbered days separated by commas and hyphens (e.g. 1-5,10-20) or a recurring named day (e.g. Every Monday)

Returns:

the set of days or recurring named day for a MONTHLY calendar period

getRecurrence

java.lang.String getRecurrence()

Get the recurring day setting for a MONTHLY calendar period. The scheduled days for a MONTHLY calendar period can be either a set of numbered days separated by commas and hyphens (e.g. 1-5,10-20) or a recurring named day (e.g. Every Monday). If there is a recurrent day setting but no named day, then simply "day" is assumed.

Returns:

EVERY, FIRST, SECOND, THIRD, FOURTH, LAST or null

getRecurrentDay

java.lang.String getRecurrentDay()

Get the recurrent named day setting for a MONTHLY calendar period. The scheduled days for a MONTHLY calendar period can be either a set of numbered days separated by commas and hyphens (e.g. 1-5,10-20) or a recurring named day (e.g. Every Monday). If there is a recurrent day setting but no named day, then simply "day" is assumed.

Returns:

SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or null

getDate

java.lang.String getDate()

Get the date for a ONE_TIME calendar period

Returns:

the date for a ONE_TIME calendar period formatted as yyyy/mm/dd

setDays

void setDays(java.lang.String days)
      throws java.lang.Exception

Set the list of named days for a WEEKLY calendar period. Day ranges are separated by hyphens (e.g. Su-Sa). Use two-letter day constants SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY. A week starts on SUNDAY, ends on SATURDAY.

Parameters:

days - the list of named days for a WEEKLY calendar period

Throws:

java.lang.Exception

setMonths

void setMonths(java.lang.String months)
        throws java.lang.Exception

Set the list of named months for a MONTHLY calendar period. Month ranges are separated by hyphens (e.g. Jan-Dec). Use three-letter month constants JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, and DECEMBER.

Parameters:

months - the list of named months for a MONTHLY calendar period

Throws:

java.lang.Exception

setDaysOfMonth

void setDaysOfMonth(java.lang.String daysOfMonth)

Set the set of numbered days for a MONTHLY calendar period. The scheduled days for a MONTHLY calendar period can be either a set of numbered days separated by commas and hyphens (e.g. 1-5,10-20) or a recurring named day (e.g. Every Monday)

Parameters:

daysOfMonth - the set of numbered days for a MONTHLY calendar period

setDaysOfMonth

void setDaysOfMonth(java.lang.String recurrence,
                    java.lang.String day)

Set the recurrence and named day for a MONTHLY calendar period. The scheduled days for a MONTHLY calendar period can be either a set of numbered days separated by commas and hyphens (e.g. 1-5,10-20) or a recurring named day (e.g. Every Monday) If there is an recurrent day setting but no named day, then simply "day" is assumed.

Parameters:

recurrence - EVERY, FIRST, SECOND, THIRD, FOURTH, or LAST

day - SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or null

setDate

void setDate(java.lang.String date)

Set the date for a ONE_TIME calendar period

Parameters:

date - the date for a ONE_TIME calendar period formatted as yyyy/mm/dd

isRecurrent

boolean isRecurrent()

Indicates whether there is a recurrent day setting for a MONTHLY calendar period. The scheduled days for a MONTHLY calendar period can be either a set of numbered days separated by commas and hyphens (e.g. 1-5,10-20) or a recurring named day (e.g. Every Monday). If there is an recurrent day setting but no named day, then simply "day" is assumed.

Returns:

true if there is an recurrent day setting; false otherwise

addTime

ISchedule.Item.Calendar.Time addTime()

Adds a new run time to the calendar

Returns:

the new time

clearTimes

void clearTimes()

Clear all of the run times for this calendar