org.kuali.hr.time.calendar.service
Interface CalendarEntriesService

All Known Implementing Classes:

CalendarEntriesServiceImpl

public interface CalendarEntriesService

Method Summary

CalendarEntries	createNextCalendarEntry(CalendarEntries calendarEntries, CalendarEntryPeriodType type)
List<CalendarEntries>	getAllCalendarEntriesForCalendarId(String hrCalendarId)
List<CalendarEntries>	getAllCalendarEntriesForCalendarIdAndYear(String hrCalendarId, String year)
CalendarEntries	getCalendarEntries(String hrCalendarEntriesId) Method to directly access the CalendarEntries object by ID.
CalendarEntries	getCalendarEntriesByBeginAndEndDate(Date beginPeriodDate, Date endPeriodDate)
CalendarEntries	getCalendarEntriesByIdAndPeriodEndDate(String hrCalendarId, Date endPeriodDate)
CalendarEntries	getCurrentCalendarEntriesByCalendarId(String hrCalendarId, Date asOfDate) Method to obtain the current CalendarEntries object based on the indicated calendar and asOfDate.
List<CalendarEntries>	getCurrentCalendarEntryNeedsScheduled(int thresholdDays, Date asOfDate) Provides a list of CalendarEntries that are in the indicated window of time from the as of date.
List<CalendarEntries>	getFutureCalendarEntries(String hrCalendarId, Date currentDate, int numberOfEntries)
CalendarEntries	getNextCalendarEntriesByCalendarId(String hrCalendarId, CalendarEntries pce)
CalendarEntries	getPreviousCalendarEntriesByCalendarId(String hrCalendarId, CalendarEntries pce)

Method Detail

getCalendarEntries

@Cacheable(value="KPME/CalendarEntries",
           key="\'hrCalendarEntriesId=\' + #p0")
CalendarEntries getCalendarEntries(String hrCalendarEntriesId)

Method to directly access the CalendarEntries object by ID.

Parameters:

hrCalendarEntriesId - The ID to retrieve.

Returns:

a CalendarEntries object.

getCurrentCalendarEntriesByCalendarId

@Cacheable(value="KPME/CalendarEntries",
           key="\'hrCalendarId=\' + #p0 + \'|\' + \'asOfDate=\' + #p1")
CalendarEntries getCurrentCalendarEntriesByCalendarId(String hrCalendarId,
                                                                Date asOfDate)

Method to obtain the current CalendarEntries object based on the indicated calendar and asOfDate.

Parameters:

hrCalendarId - The calendar to reference.

asOfDate - The date reference point.

Returns:

the current CalendarEntries effective by the asOfDate.

getCalendarEntriesByIdAndPeriodEndDate

@Cacheable(value="KPME/CalendarEntries",
           key="\'hrCalendarId=\' + #p0 + \'|\' + \'endPeriodDate=\' + #p1")
CalendarEntries getCalendarEntriesByIdAndPeriodEndDate(String hrCalendarId,
                                                                 Date endPeriodDate)

getPreviousCalendarEntriesByCalendarId

CalendarEntries getPreviousCalendarEntriesByCalendarId(String hrCalendarId,
                                                       CalendarEntries pce)

getNextCalendarEntriesByCalendarId

CalendarEntries getNextCalendarEntriesByCalendarId(String hrCalendarId,
                                                   CalendarEntries pce)

getCurrentCalendarEntryNeedsScheduled

@Cacheable(value="KPME/CalendarEntries",
           key="\'thresholdDays=\' + #p0 + \'|\' + \'endPeriodDate=\' + #p1")
List<CalendarEntries> getCurrentCalendarEntryNeedsScheduled(int thresholdDays,
                                                                      Date asOfDate)

Provides a list of CalendarEntries that are in the indicated window of time from the as of date.

Parameters:

thresholdDays - ± days from the asOfDate to form the window of time.

asOfDate - The central date to query from.

Returns:

A list of CalendarEntries.

createNextCalendarEntry

CalendarEntries createNextCalendarEntry(CalendarEntries calendarEntries,
                                        CalendarEntryPeriodType type)

getFutureCalendarEntries

List<CalendarEntries> getFutureCalendarEntries(String hrCalendarId,
                                               Date currentDate,
                                               int numberOfEntries)

getCalendarEntriesByBeginAndEndDate

CalendarEntries getCalendarEntriesByBeginAndEndDate(Date beginPeriodDate,
                                                    Date endPeriodDate)

getAllCalendarEntriesForCalendarId

@Cacheable(value="KPME/CalendarEntries",
           key="\'hrCalendarId=\' + #p0")
List<CalendarEntries> getAllCalendarEntriesForCalendarId(String hrCalendarId)

getAllCalendarEntriesForCalendarIdAndYear

@Cacheable(value="KPME/CalendarEntries",
           key="\'hrCalendarId=\' + #p0 + \'|\' + \'year=\' + #p1")
List<CalendarEntries> getAllCalendarEntriesForCalendarIdAndYear(String hrCalendarId,
                                                                          String year)