org.kuali.kpme.tklm.api.time.calendar
Interface TkCalendarContract

All Superinterfaces:

CalendarParentContract

All Known Implementing Classes:

TkCalendar

public interface TkCalendarContract
extends CalendarParentContract

TkCalendarContract interface

Method Summary

org.joda.time.DateTime	getBeginDateTime() The beginDateTime associated with the TkCalendar
String	getCalenadrYear() The year portion of beginDateTime associated with the TkCalendar
List<String>	getCalendarDayHeadings() The list of string titles for each row block (day) associated with the TkCalendar
String	getCalendarMonth() The month portion of beginDateTime associated with the TkCalendar
String	getCalendarTitle() The string for calendar title use associated with the TkCalendar
org.joda.time.DateTime	getEndDateTime() The endDateTime associated with the TkCalendar
CalendarEntryContract	getPayCalEntry() The payCalEntry object associated with the TkCalendar

Methods inherited from interface org.kuali.kpme.core.api.calendar.CalendarParentContract

getCalendarEntry, getWeeks

Method Detail

getPayCalEntry

CalendarEntryContract getPayCalEntry()

The payCalEntry object associated with the TkCalendar

payCalEntry of a TkCalendar

Returns:

payCalEntry for TkCalendar

getBeginDateTime

org.joda.time.DateTime getBeginDateTime()

The beginDateTime associated with the TkCalendar

beginDateTime of a TkCalendar

Specified by:

getBeginDateTime in interface CalendarParentContract

Returns:

beginDateTime for TkCalendar

getEndDateTime

org.joda.time.DateTime getEndDateTime()

The endDateTime associated with the TkCalendar

endDateTime of a TkCalendar

Specified by:

getEndDateTime in interface CalendarParentContract

Returns:

endDateTime for TkCalendar

getCalendarTitle

String getCalendarTitle()

The string for calendar title use associated with the TkCalendar

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

Specified by:

getCalendarTitle in interface CalendarParentContract

Returns:

a string for calendar title use for TkCalendar

getCalendarDayHeadings

List<String> getCalendarDayHeadings()

The list of string titles for each row block (day) associated with the TkCalendar

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

Specified by:

getCalendarDayHeadings in interface CalendarParentContract

Returns:

a list of string titles for each row block (day) for TkCalendar

getCalenadrYear

String getCalenadrYear()

The year portion of beginDateTime associated with the TkCalendar

year portion of beginDateTime of a TkCalendar

Returns:

getBeginDateTime().toString("yyyy") for TkCalendar

getCalendarMonth

String getCalendarMonth()

The month portion of beginDateTime associated with the TkCalendar

month portion of beginDateTime of a TkCalendar

Returns:

getBeginDateTime().toString("M") for TkCalendar