org.kuali.kra.scheduling.service.impl

Class ScheduleServiceImpl

java.lang.Object

org.kuali.kra.scheduling.service.impl.ScheduleServiceImpl

All Implemented Interfaces:

ScheduleService

@Transactional
public class ScheduleServiceImpl
extends Object
implements ScheduleService

This class is thread safe implementation of ScheduleService interface. Primary function of this service implementation is to return generated schedule dates using parameters passed.

Constructor Summary

Constructors

Constructor and Description
ScheduleServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
List<Date>	getIntervalInDaysScheduledDates(Date startDate, Date endDate, Time24HrFmt time, Integer intervalInDays) This implementation uses the SimpleTrigger class instead of the CronTrigger class used everywhere else.
protected List<Date>	getScheduledDates(CronExpression expression, Date startDate, Date endDate, Time24HrFmt time, ScheduleSequence scheduleSequence) This is helper method, gets appropriate ScheduleSequence in case of null, wraps time accurately and executes schedule sequence.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, CronSpecialChars[] weekdays, ScheduleSequence scheduleSequence) This overloaded implementation uses WeekCronExpression targeting weekly types of schedule generation.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, CronSpecialChars weekOfMonth, CronSpecialChars dayOfWeek, CronSpecialChars month, Integer frequencyInYear, ScheduleSequence scheduleSequence) This overloaded implementation uses YearMonthDayCronExpression targeting yearly types of schedule generation.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, CronSpecialChars dayOfWeek, CronSpecialChars weekOfMonth, Integer frequencyInMonth, ScheduleSequence scheduleSequence) This overloaded implementation uses MonthDayCronExpression targeting monthly types of schedule generation.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, CronSpecialChars month, Integer day, Integer frequencyInYear, ScheduleSequence scheduleSequence) This overloaded implementation uses YearMonthDayCronExpression targeting yearly types of schedule generation.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, Integer day, Integer frequencyInMonth, ScheduleSequence scheduleSequence) This overloaded implementation uses MonthDayCronExpression targeting monthly types of schedule generation.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, Integer frequencyInDay, ScheduleSequence scheduleSequence) This overloaded implementation uses DayCronExpression targeting daily types of schedule generation.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, ScheduleSequence scheduleSequence) This overloaded implementation uses NeverCronExpression, which generates schedule for specific DAY only.
List<Date>	getScheduledDates(Date startDate, Date endDate, Time24HrFmt time, ScheduleSequence scheduleSequence, Integer dayOfMonth) This overloaded implementation uses MonthDayMultipleYearsCronExpression targeting monthly types of schedule generation.
protected ScheduleSequence	getScheduleSequence(ScheduleSequence scheduleSequence) This is helper method, if ScheduleSequence passed is null it will construct new DefaultScheduleSequence.
protected Date	wrapTime(Date date, Time24HrFmt time) This is helper method, wraps date with time accurately in java.util.Date (milliseconds).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScheduleServiceImpl

public ScheduleServiceImpl()

Method Detail

getScheduledDates

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

This overloaded implementation uses NeverCronExpression, which generates schedule for specific DAY only. Note: Start date's day is used while building NeverCronExpression as specific DAY.

Specified by:

getScheduledDates in interface ScheduleService

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

See Also:

org.kuali.kra.scheduling.service.impl.ScheduleService#getScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, org.kuali.kra.scheduling.sequence.ScheduleSequence)

getScheduledDates

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

This overloaded implementation uses DayCronExpression targeting daily types of schedule generation.

Specified by:

getScheduledDates in interface ScheduleService

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

See Also:

org.kuali.kra.scheduling.service.impl.ScheduleService#getScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, java.lang.Integer, org.kuali.kra.scheduling.sequence.ScheduleSequence)

getScheduledDates

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

This overloaded implementation uses WeekCronExpression targeting weekly types of schedule generation.

Specified by:

getScheduledDates in interface ScheduleService

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

See Also:

org.kuali.kra.scheduling.service.impl.ScheduleService#getScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, org.kuali.kra.scheduling.expr.util.CronSpecialChars[], org.kuali.kra.scheduling.sequence.ScheduleSequence)

getScheduledDates

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

This overloaded implementation uses MonthDayCronExpression targeting monthly types of schedule generation.

Specified by:

getScheduledDates in interface ScheduleService

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

day - is day of month.

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

Returns:

List of date sequence generated.

Throws:

ParseException

See Also:

org.kuali.kra.scheduling.service.impl.ScheduleService#getScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, java.lang.Integer, java.lang.Integer, org.kuali.kra.scheduling.sequence.ScheduleSequence)

getScheduledDates

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

This overloaded implementation uses MonthDayMultipleYearsCronExpression targeting monthly types of schedule generation.

Specified by:

getScheduledDates in interface ScheduleService

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

See Also:

ScheduleService.getScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, org.kuali.kra.scheduling.sequence.ScheduleSequence, java.lang.Integer)

getScheduledDates

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

This overloaded implementation uses MonthDayCronExpression targeting monthly types of schedule generation.

Specified by:

getScheduledDates in interface ScheduleService

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.

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

Returns:

List of date sequence generated.

Throws:

ParseException

See Also:

org.kuali.kra.scheduling.service.impl.ScheduleService#getScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, org.kuali.kra.scheduling.expr.util.CronSpecialChars, org.kuali.kra.scheduling.expr.util.CronSpecialChars, java.lang.Integer, org.kuali.kra.scheduling.sequence.ScheduleSequence)

getScheduledDates

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

This overloaded implementation uses YearMonthDayCronExpression targeting yearly types of schedule generation.

Specified by:

getScheduledDates in interface ScheduleService

Parameters:

startDate - is begin date.

endDate - is end date.

time - is time.

month - is CronSpecialChars defining month.

day - is day of month.

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

Returns:

List of date sequence generated.

Throws:

ParseException

See Also:

org.kuali.kra.scheduling.service.impl.ScheduleService#getScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, org.kuali.kra.scheduling.expr.util.CronSpecialChars, java.lang.Integer, java.lang.Integer, org.kuali.kra.scheduling.sequence.ScheduleSequence)

getScheduledDates

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

This overloaded implementation uses YearMonthDayCronExpression targeting yearly types of schedule generation.

Specified by:

getScheduledDates in interface ScheduleService

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.

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

Returns:

List of date sequence generated.

Throws:

ParseException

See Also:

org.kuali.kra.scheduling.service.impl.ScheduleService#getScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, org.kuali.kra.scheduling.expr.util.CronSpecialChars, org.kuali.kra.scheduling.expr.util.CronSpecialChars, org.kuali.kra.scheduling.expr.util.CronSpecialChars, java.lang.Integer, org.kuali.kra.scheduling.sequence.ScheduleSequence)

getScheduledDates

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

This is helper method, gets appropriate ScheduleSequence in case of null, wraps time accurately and executes schedule sequence.

Parameters:

expression - expects valid cron expression.

startDate - is begin date of sequence.

endDate - is end date of sequence.

time - at which schedule is held.

scheduleSequence - executes schedule sequence based on implementation of the ScheduleSequence.

Returns:

List of valid schedule dates between start and end date.

Throws:

ParseException

wrapTime

protected Date wrapTime(Date date,
            Time24HrFmt time)

This is helper method, wraps date with time accurately in java.util.Date (milliseconds).

Parameters:

date - to be wrapped.

time - to be added to date.

Returns:

wrapped date & time.

getScheduleSequence

protected ScheduleSequence getScheduleSequence(ScheduleSequence scheduleSequence)

This is helper method, if ScheduleSequence passed is null it will construct new DefaultScheduleSequence.

Parameters:

scheduleSequence -

Returns:

ScheduleSequence after sanity check.

getIntervalInDaysScheduledDates

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

This implementation uses the SimpleTrigger class instead of the CronTrigger class used everywhere else. We need repeating intervals of some particular number of days and cron expressions are not suited for creating absolute-interval based repeating schedules. We also do some post processing to the dates obtained via simple trigger in order to keep the same time of day even if the schedule dates cross daylight savings boundaries.

Specified by:

getIntervalInDaysScheduledDates in interface ScheduleService

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

See Also:

ScheduleService.getIntervalInDaysScheduledDates(java.util.Date, java.util.Date, org.kuali.kra.scheduling.util.Time24HrFmt, java.lang.Integer)