org.kuali.hr.time.util
Class TkTimeBlockAggregate

java.lang.Object
  org.kuali.hr.time.util.TkTimeBlockAggregate

public class TkTimeBlockAggregate
extends Object

Constructor Summary

TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntries payCalendarEntry)
Defaults to using SYSTEM time zone.

TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntries payCalendarEntry, Calendar payCalendar)
Defaults to using SYSTEM time zone.

TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntries payCalendarEntry, Calendar payCalendar, boolean useUserTimeZone)
Provides the option to refer to the time zone adjusted time for the current user.

TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntries payCalendarEntry, Calendar payCalendar, boolean useUserTimeZone, List<org.joda.time.Interval> dayIntervals)

TkTimeBlockAggregate(List<TimeBlock> timeBlocks, List<LeaveBlock> leaveBlocks, CalendarEntries payCalendarEntry)
Defaults to using SYSTEM time zone.

TkTimeBlockAggregate(List<TimeBlock> timeBlocks, List<LeaveBlock> leaveBlocks, CalendarEntries payCalendarEntry, Calendar payCalendar)
Defaults to using SYSTEM time zone.

TkTimeBlockAggregate(List<TimeBlock> timeBlocks, List<LeaveBlock> leaveBlocks, CalendarEntries payCalendarEntry, Calendar payCalendar, boolean useUserTimeZone)
Provides the option to refer to the time zone adjusted time for the current user.

TkTimeBlockAggregate(List<TimeBlock> timeBlocks, List<LeaveBlock> leaveBlocks, CalendarEntries payCalendarEntry, Calendar payCalendar, boolean useUserTimeZone, List<org.joda.time.Interval> dayIntervals)

Method Summary

static TkTimeBlockAggregate	combineTimeAndLeaveAggregates(TkTimeBlockAggregate tbAggregate, LeaveBlockAggregate lbAggregate)
List<List<LeaveBlock>>	getDayLeaveBlockList()
List<List<TimeBlock>>	getDayTimeBlockList()
List<LeaveBlock>	getFlattenedLeaveBlockList()
List<TimeBlock>	getFlattenedTimeBlockList()
List<FlsaWeek>	getFlsaWeeks(org.joda.time.DateTimeZone zone) When consuming these weeks, you must be aware that you could be on a virtual day, ie noon to noon schedule and have your FLSA time start before the virtual day start, but still have a full 7 days for your week.
List<List<FlsaWeek>>	getFlsaWeeks(org.joda.time.DateTimeZone zone, String principalId)
Calendar	getPayCalendar()
CalendarEntries	getPayCalendarEntry()
List<List<LeaveBlock>>	getWeekLeaveBlocks(int week) Provides a way to access all of the leave blocks for a given week.
List<List<TimeBlock>>	getWeekTimeBlocks(int week) Provides a way to access all of the time blocks for a given week.
int	numberOfAggregatedWeeks()
void	setPayCalendar(Calendar payCalendar)
void	setPayCalendarEntry(CalendarEntries payCalendarEntry)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                            CalendarEntries payCalendarEntry)

Defaults to using SYSTEM time zone.

Parameters:

timeBlocks -

payCalendarEntry -

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                            CalendarEntries payCalendarEntry,
                            Calendar payCalendar)

Defaults to using SYSTEM time zone.

Parameters:

timeBlocks -

payCalendarEntry -

payCalendar -

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                            CalendarEntries payCalendarEntry,
                            Calendar payCalendar,
                            boolean useUserTimeZone)

Provides the option to refer to the time zone adjusted time for the current user.

Parameters:

timeBlocks -

payCalendarEntry -

payCalendar -

useUserTimeZone -

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                            CalendarEntries payCalendarEntry,
                            Calendar payCalendar,
                            boolean useUserTimeZone,
                            List<org.joda.time.Interval> dayIntervals)

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                            List<LeaveBlock> leaveBlocks,
                            CalendarEntries payCalendarEntry)

Defaults to using SYSTEM time zone.

Parameters:

timeBlocks -

leaveBlocks -

payCalendarEntry -

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                            List<LeaveBlock> leaveBlocks,
                            CalendarEntries payCalendarEntry,
                            Calendar payCalendar)

Defaults to using SYSTEM time zone.

Parameters:

timeBlocks -

leaveBlocks -

payCalendarEntry -

payCalendar -

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                            List<LeaveBlock> leaveBlocks,
                            CalendarEntries payCalendarEntry,
                            Calendar payCalendar,
                            boolean useUserTimeZone)

Provides the option to refer to the time zone adjusted time for the current user.

Parameters:

timeBlocks -

payCalendarEntry -

payCalendar -

useUserTimeZone -

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                            List<LeaveBlock> leaveBlocks,
                            CalendarEntries payCalendarEntry,
                            Calendar payCalendar,
                            boolean useUserTimeZone,
                            List<org.joda.time.Interval> dayIntervals)

Method Detail

getFlattenedTimeBlockList

public List<TimeBlock> getFlattenedTimeBlockList()

getFlattenedLeaveBlockList

public List<LeaveBlock> getFlattenedLeaveBlockList()

getWeekTimeBlocks

public List<List<TimeBlock>> 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 -

Returns:

getWeekLeaveBlocks

public List<List<LeaveBlock>> 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 -

Returns:

getFlsaWeeks

public List<FlsaWeek> getFlsaWeeks(org.joda.time.DateTimeZone zone)

When consuming these weeks, you must be aware that you could be on a virtual day, ie noon to noon schedule and have your FLSA time start before the virtual day start, but still have a full 7 days for your week.

Parameters:

zone - The TimeZone to use when constructing this relative sorting.

getFlsaWeeks

public List<List<FlsaWeek>> getFlsaWeeks(org.joda.time.DateTimeZone zone,
                                         String principalId)

numberOfAggregatedWeeks

public int numberOfAggregatedWeeks()

Returns:

the total number of weeks that this object represents.

getDayTimeBlockList

public List<List<TimeBlock>> getDayTimeBlockList()

getDayLeaveBlockList

public List<List<LeaveBlock>> getDayLeaveBlockList()

getPayCalendarEntry

public CalendarEntries getPayCalendarEntry()

setPayCalendarEntry

public void setPayCalendarEntry(CalendarEntries payCalendarEntry)

getPayCalendar

public Calendar getPayCalendar()

setPayCalendar

public void setPayCalendar(Calendar payCalendar)

combineTimeAndLeaveAggregates

public static TkTimeBlockAggregate combineTimeAndLeaveAggregates(TkTimeBlockAggregate tbAggregate,
                                                                 LeaveBlockAggregate lbAggregate)