org.kuali.kpme.tklm.api.time.util
Interface TkTimeBlockAggregateContract

All Known Implementing Classes:

TkTimeBlockAggregate

public interface TkTimeBlockAggregateContract

TkTimeBlockAggregateContract interface

Method Summary

List<? extends List<? extends LeaveBlockContract>>	getDayLeaveBlockList() The list of day LeaveBlock objects associated with the TkTimeBlockAggregate
List<? extends List<? extends TimeBlockContract>>	getDayTimeBlockList() The list of day TimeBlock objects associated with the TkTimeBlockAggregate
List<? extends LeaveBlockContract>	getFlattenedLeaveBlockList() The list of LeaveBlock objects associated with the TkTimeBlockAggregate
List<? extends TimeBlockContract>	getFlattenedTimeBlockList() The list of TimeBlock objects associated with the TkTimeBlockAggregate
List<? extends FlsaWeekContract>	getFlsaWeeks(org.joda.time.DateTimeZone zone, int flsaDay, boolean isflsaDayPassed) TODO: Put a better comment The list of flsa weeks associated with the TkTimeBlockAggregate
List<? extends List<? extends FlsaWeekContract>>	getFlsaWeeks(org.joda.time.DateTimeZone zone, String principalId) TODO: Put a better comment The list of flsa weeks associated with the TkTimeBlockAggregate
CalendarContract	getPayCalendar() The Calendar object associated with the TkTimeBlockAggregate
CalendarEntryContract	getPayCalendarEntry() The CalendarEntry object associated with the TkTimeBlockAggregate
List<? extends List<? extends LeaveBlockContract>>	getWeekLeaveBlocks(int week) Provides a way to access all of the leave blocks for a given week
List<? extends List<? extends TimeBlockContract>>	getWeekTimeBlocks(int week) Provides a way to access all of the time blocks for a given week
int	numberOfAggregatedWeeks() The number of aggregated weeks associated with the TkTimeBlockAggregate

Method Detail

getFlattenedTimeBlockList

List<? extends TimeBlockContract> getFlattenedTimeBlockList()

The list of TimeBlock objects associated with the TkTimeBlockAggregate

the list of flattened time blocks of a TkTimeBlockAggregate

Returns:

the list of flattened time blocks for TkTimeBlockAggregate

getFlattenedLeaveBlockList

List<? extends LeaveBlockContract> getFlattenedLeaveBlockList()

The list of LeaveBlock objects associated with the TkTimeBlockAggregate

the list of flattened leave blocks of a TkTimeBlockAggregate

Returns:

the list of flattened leave blocks for TkTimeBlockAggregate

getWeekTimeBlocks

List<? extends List<? extends TimeBlockContract>> getWeekTimeBlocks(int week)

Provides a way to access all of the time 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 = getWeekTimeBlocks(0); List day0 = week0.get(0);

Parameters:

week - to retrieve time blocks for

Returns:

the list of time blocks for a given week

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 leave blocks for that day. Ex. List> week0 = getWeekLeaveBlocks(0); List day0 = week0.get(0);

Parameters:

week - to retrieve leave blocks for

Returns:

the list of leave blocks for a given week

getFlsaWeeks

List<? extends FlsaWeekContract> getFlsaWeeks(org.joda.time.DateTimeZone zone,
                                              int flsaDay,
                                              boolean isflsaDayPassed)

TODO: Put a better comment The list of flsa weeks associated with the TkTimeBlockAggregate

the list of flsa weeks of a TkTimeBlockAggregate

Parameters:

The - TimeZone to use when constructing this relative sorting

Returns:

the list of flsa weeks for TkTimeBlockAggregate

getFlsaWeeks

List<? extends List<? extends FlsaWeekContract>> getFlsaWeeks(org.joda.time.DateTimeZone zone,
                                                              String principalId)

TODO: Put a better comment The list of flsa weeks associated with the TkTimeBlockAggregate

the list of flsa weeks of a TkTimeBlockAggregate

Parameters:

zone -

principalId -

Returns:

the list of flsa weeks for TkTimeBlockAggregate

numberOfAggregatedWeeks

int numberOfAggregatedWeeks()

The number of aggregated weeks associated with the TkTimeBlockAggregate

Returns:

the number of weeks that this object represents.

getDayTimeBlockList

List<? extends List<? extends TimeBlockContract>> getDayTimeBlockList()

The list of day TimeBlock objects associated with the TkTimeBlockAggregate

dayTimeBlockList of a TkTimeBlockAggregate

Returns:

dayTimeBlockList for TkTimeBlockAggregate

getDayLeaveBlockList

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

The list of day LeaveBlock objects associated with the TkTimeBlockAggregate

dayLeaveBlockList of a TkTimeBlockAggregate

Returns:

dayLeaveBlockList for TkTimeBlockAggregate

getPayCalendarEntry

CalendarEntryContract getPayCalendarEntry()

The CalendarEntry object associated with the TkTimeBlockAggregate

payCalendarEntry of a TkTimeBlockAggregate

Returns:

payCalendarEntry for TkTimeBlockAggregate

getPayCalendar

CalendarContract getPayCalendar()

The Calendar object associated with the TkTimeBlockAggregate

payCalendar of a TkTimeBlockAggregate

Returns:

payCalendar for TkTimeBlockAggregate