org.kuali.kra.scheduling.service

Interface ScheduleService

All Known Implementing Classes:

ScheduleServiceImpl

public interface ScheduleService

Method Summary

Methods

Modifier and Type	Method and Description
List<Date>	getIntervalInDaysScheduledDates(Date startDate, Date endDate, Time24HrFmt time, Integer intervalInDays) This method must return schedule dates generated between provided parameters.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, CronSpecialChars[] weekdays, ScheduleSequence scheduleSequence) This method must return schedule dates generated between provided parameters.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, CronSpecialChars weekOfMonth, CronSpecialChars dayOfWeek, CronSpecialChars month, Integer frequencyInYear, ScheduleSequence scheduleSequence) This method must return schedule dates generated between provided parameters.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, CronSpecialChars dayOfWeek, CronSpecialChars weekOfMonth, Integer frequencyInMonth, ScheduleSequence scheduleSequence) This method must return schedule dates generated between provided parameters.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, CronSpecialChars month, Integer day, Integer frequencyInYear, ScheduleSequence scheduleSequence) This method must return schedule dates generated between provided parameters.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, Integer day, Integer frequencyInMonth, ScheduleSequence scheduleSequence) This method must return schedule dates generated between provided parameters.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, Integer frequencyInDay, ScheduleSequence scheduleSequence) This method must return schedule dates generated between provided parameters.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, ScheduleSequence scheduleSequence) This method must return schedule dates generated between provided parameters.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, ScheduleSequence scheduleSequence, Integer dayOfMonth) This method must return schedule dates generated between provided parameters.

Method Detail

getScheduledDates

List<Date> getScheduledDates(Date startDate,
                           Date endDate,
                           Time24HrFmt time,
                           ScheduleSequence scheduleSequence)
                             throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

scheduleSequence - to used for generating sequence. If value passed is null, DefaultScheduleSequnce will be used.

Returns:

List of date sequence generated.

Throws:

ParseException

getScheduledDates

List<Date> getScheduledDates(Date startDate,
                           Date endDate,
                           Time24HrFmt time,
                           Integer frequencyInDay,
                           ScheduleSequence scheduleSequence)
                             throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

frequencyInDay -

scheduleSequence - to used for generating sequence. If value passed is null, DefaultScheduleSequnce will be used.

Returns:

List of date sequence generated.

Throws:

ParseException

getIntervalInDaysScheduledDates

List<Date> getIntervalInDaysScheduledDates(Date startDate,
                                         Date endDate,
                                         Time24HrFmt time,
                                         Integer intervalInDays)
                                           throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

intervalInDays - is the number of days in each repeating interval

Returns:

List of date sequence generated.

Throws:

ParseException

getScheduledDates

List<Date> getScheduledDates(Date startDate,
                           Date endDate,
                           Time24HrFmt time,
                           CronSpecialChars[] weekdays,
                           ScheduleSequence scheduleSequence)
                             throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

weekdays - is array of CronSpecialChars containing week day values.

scheduleSequence - to used for generating sequence. If value passed is null, DefaultScheduleSequnce will be used.

Returns:

List of date sequence generated.

Throws:

ParseException

getScheduledDates

List<Date> getScheduledDates(Date startDate,
                           Date endDate,
                           Time24HrFmt time,
                           Integer day,
                           Integer frequencyInMonth,
                           ScheduleSequence scheduleSequence)
                             throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

day - is day of month.

frequencyInMonth -

scheduleSequence - to used for generating sequence. If value passed is null, DefaultScheduleSequnce will be used.

Returns:

List of date sequence generated.

Throws:

ParseException

getScheduledDates

List<Date> getScheduledDates(Date startDate,
                           Date endDate,
                           Time24HrFmt time,
                           ScheduleSequence scheduleSequence,
                           Integer dayOfMonth)
                             throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

day - is day of month.

frequencyInMonth -

scheduleSequence - to used for generating sequence. If value passed is null, DefaultScheduleSequnce will be used.

Returns:

List of date sequence generated.

Throws:

ParseException

getScheduledDates

List<Date> getScheduledDates(Date startDate,
                           Date endDate,
                           Time24HrFmt time,
                           CronSpecialChars dayOfWeek,
                           CronSpecialChars weekOfMonth,
                           Integer frequencyInMonth,
                           ScheduleSequence scheduleSequence)
                             throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

dayOfWeek - is CronSpecialChars defining day of week.

weekOfMonth - is CronSpecialChars defining week of month.

frequencyInMonth -

scheduleSequence - to used for generating sequence. If value passed is null, DefaultScheduleSequnce will be used.

Returns:

List of date sequence generated.

Throws:

ParseException

getScheduledDates

List<Date> getScheduledDates(Date startDate,
                           Date endDate,
                           Time24HrFmt time,
                           CronSpecialChars month,
                           Integer day,
                           Integer frequencyInYear,
                           ScheduleSequence scheduleSequence)
                             throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

month - is CronSpecialChars defining month.

day - is day of month.

frequencyInYear -

scheduleSequence - to used for generating sequence. If value passed is null, DefaultScheduleSequnce will be used.

Returns:

List of date sequence generated.

Throws:

ParseException

getScheduledDates

List<Date> getScheduledDates(Date startDate,
                           Date endDate,
                           Time24HrFmt time,
                           CronSpecialChars weekOfMonth,
                           CronSpecialChars dayOfWeek,
                           CronSpecialChars month,
                           Integer frequencyInYear,
                           ScheduleSequence scheduleSequence)
                             throws ParseException

This method must return schedule dates generated between provided parameters.

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

weekOfMonth - is CronSpecialChars defining week of month.

dayOfWeek - is CronSpecialChars defining day of week.

month - is CronSpecialChars defining month.

frequencyInYear -

scheduleSequence - to used for generating sequence. If value passed is null, DefaultScheduleSequnce will be used.

Returns:

List of date sequence generated.

Throws:

ParseException