org.kuali.kpme.tklm.api.leave.block
Interface LeaveBlockAggregateContract

All Known Implementing Classes:

LeaveBlockAggregate

public interface LeaveBlockAggregateContract

LeaveBlockAggregateContract interface

Method Summary

List<? extends List<? extends LeaveBlockContract>>	getDayLeaveBlockList() The dayLeaveBlockList associated with the LeaveBlockAggregate
List<? extends LeaveBlockContract>	getFlattenedLeaveBlockList() The dayLeaveBlockListist that has been sorted by timestamp for the LeaveBlockAggregateContract
LeaveCalendarContract	getLeaveCalendar() The LeaveCalendar object associated with the LeaveBlockAggregate
CalendarEntryContract	getleaveCalendarEntry() The CalendarEntry object associated with the LeaveBlockAggregate
List<? extends List<? extends LeaveBlockContract>>	getWeekLeaveBlocks(int week) Provides a way to access all of the leave blocks for a given week.
int	numberOfAggregatedWeeks() The total number of weeks that the LeaveBlockAggregate represents

Method Detail

getFlattenedLeaveBlockList

List<? extends LeaveBlockContract> getFlattenedLeaveBlockList()

The dayLeaveBlockListist that has been sorted by timestamp for the LeaveBlockAggregateContract

a sorted dayLeaveBlockList of a LeaveBlockAggregate

Returns:

a sorted dayLeaveBlockList for LeaveBlockAggregate

getWeekLeaveBlocks

List<? extends List<? extends LeaveBlockContract>> getWeekLeaveBlocks(int week)

Provides a way to access all of the leave blocks for a given week.

Outer list is 0 indexed list representing days in a week. Inner List are all of the time blocks for that day. Ex. List> week0 = getWeekLeaveBlocks(0); List day0 = week0.get(0);

Parameters:

week - (integer) to retrieve the leave blocks for

Returns:

the total number of weeks for LeaveBlockAggregate

numberOfAggregatedWeeks

int numberOfAggregatedWeeks()

The total number of weeks that the LeaveBlockAggregate represents

the total number of weeks of a LeaveBlockAggregate

Returns:

the total number of weeks

getDayLeaveBlockList

List<? extends List<? extends LeaveBlockContract>> getDayLeaveBlockList()

The dayLeaveBlockList associated with the LeaveBlockAggregate

dayLeaveBlockList of a LeaveBlockAggregate

Returns:

dayLeaveBlockList for LeaveBlockAggregate

getleaveCalendarEntry

CalendarEntryContract getleaveCalendarEntry()

The CalendarEntry object associated with the LeaveBlockAggregate

leaveCalendarEntry of a LeaveBlockAggregate

Returns:

leaveCalendarEntry for LeaveBlockAggregate

getLeaveCalendar

LeaveCalendarContract getLeaveCalendar()

The LeaveCalendar object associated with the LeaveBlockAggregate

leaveCalendar of a LeaveBlockAggregate

Returns:

leaveCalendar for LeaveBlockAggregate