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

All Known Implementing Classes:

CalendarServiceImpl

public interface CalendarService

Method Summary

Calendar	getCalendar(String hrCalendarId) Fetch a pay calendar with the given id
Calendar	getCalendarByGroup(String calendarName) Fetch a pay calendar by group
Calendar	getCalendarByPrincipalIdAndDate(String principalId, Date asOfDate) Fetch a pay calendar with the given principalId and date, returns null if none found
CalendarEntries	getCalendarDatesByPayEndDate(String principalId, Date payEndDate, String calendarType) A method to use specifically when you have a Timesheet Documents Pay Period end date.
CalendarEntries	getCurrentCalendarDates(String principalId, Date currentDate) Use this method to get CalendarEntries if you are passing in a "current date" style of date, ie todays date.
CalendarEntries	getPreviousCalendarEntry(String tkCalendarId, Date beginDateCurrentCalendar) Returns the Pay CalendarEntry for previous pay calendar

Method Detail

getCalendar

@Cacheable(value="KPME/Calendar",
           key="\'hrCalendarId=\' + #p0")
Calendar getCalendar(String hrCalendarId)

Fetch a pay calendar with the given id

Parameters:

hrCalendarId -

Returns:

getCalendarByGroup

@Cacheable(value="KPME/Calendar",
           key="\'calendarName=\' + #p0")
Calendar getCalendarByGroup(String calendarName)

Fetch a pay calendar by group

Parameters:

calendarName -

Returns:

getCurrentCalendarDates

CalendarEntries getCurrentCalendarDates(String principalId,
                                        Date currentDate)

Use this method to get CalendarEntries if you are passing in a "current date" style of date, ie todays date. If you are in a logic situation where you would pass EITHER todays date or a pay calendar date, pass the Pay period BEGIN date, so that the retrieval logic will correctly place the date in the window.

Parameters:

principalId -

currentDate -

Returns:

getCalendarDatesByPayEndDate

@Cacheable(value="KPME/Calendar",
           key="\'principalId=\' + #p0 + \'|\' + \'payEndDate=\' + #p1 + \'|\' + \'calendarType=\' + #p2")
CalendarEntries getCalendarDatesByPayEndDate(String principalId,
                                                       Date payEndDate,
                                                       String calendarType)

A method to use specifically when you have a Timesheet Documents Pay Period end date. Do not use if you are passing in a date known not to be the END period date.

Parameters:

principalId -

payEndDate -

Returns:

getPreviousCalendarEntry

@Cacheable(value="KPME/Calendar",
           key="\'tkCalendarId=\' + #p0 + \'|\' + \'beginDateCurrentCalendar=\' + #p1")
CalendarEntries getPreviousCalendarEntry(String tkCalendarId,
                                                   Date beginDateCurrentCalendar)

Returns the Pay CalendarEntry for previous pay calendar

Parameters:

tkCalendarId -

beginDateCurrentCalendar -

Returns:

getCalendarByPrincipalIdAndDate

Calendar getCalendarByPrincipalIdAndDate(String principalId,
                                         Date asOfDate)

Fetch a pay calendar with the given principalId and date, returns null if none found

Parameters:

principalId -

asOfDate -

Returns: