org.kuali.kpme.core.api.calendar

Interface CalendarParentContract

All Known Subinterfaces:

LeaveCalendarContract, TkCalendarContract

All Known Implementing Classes:

CalendarParent, LeaveCalendar, LeaveRequestCalendar, TkCalendar

public interface CalendarParentContract

CalendarParentContract interface

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.DateTime	getBeginDateTime() The being date time the CalendarParent is associated with
List<String>	getCalendarDayHeadings() The calendar day headings the CalendarParent is associated with
CalendarEntry	getCalendarEntry() The CalendarEntry object the CalendarParent is associated with
String	getCalendarTitle() The calendar title/heading the CalendarParent is associated with
org.joda.time.DateTime	getEndDateTime() The end date time the CalendarParent is associated with
List<? extends CalendarWeekContract>	getWeeks() The list of CalendarWeek objects the CalendarParent is associated with

Method Detail

getBeginDateTime

org.joda.time.DateTime getBeginDateTime()

The being date time the CalendarParent is associated with

beginDateTime of a CalendarParent

Returns:

beginDateTime of CalendarParent

getEndDateTime

org.joda.time.DateTime getEndDateTime()

The end date time the CalendarParent is associated with

endDateTime of a CalendarParent

Returns:

endDateTime of CalendarParent

getCalendarEntry

CalendarEntry getCalendarEntry()

The CalendarEntry object the CalendarParent is associated with

calendarEntry of a CalendarParent

Returns:

calendarEntry of CalendarParent

getWeeks

List<? extends CalendarWeekContract> getWeeks()

The list of CalendarWeek objects the CalendarParent is associated with

weeks of a CalendarParent

Returns:

weeks of CalendarParent

getCalendarTitle

String getCalendarTitle()

The calendar title/heading the CalendarParent is associated with

If the Pay Calendar entry spans multiple months, you get Abbreviated Month name + year of both the beginning month and the ending month.

Returns:

String for calendar title use

getCalendarDayHeadings

List<String> getCalendarDayHeadings()

The calendar day headings the CalendarParent is associated with

Assumption of 7 "days" per week, or 7 "blocks" per row.

Returns:

A list of string titles for each row block (day)