org.kuali.kpme.tklm.time.util

Class TkTimeBlockAggregate

java.lang.Object

org.kuali.kpme.tklm.time.util.TkTimeBlockAggregate

All Implemented Interfaces:

TkTimeBlockAggregateContract

public class TkTimeBlockAggregate
extends Object
implements TkTimeBlockAggregateContract

Constructor Summary

Constructors

Constructor and Description
TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntry payCalendarEntry) Defaults to using SYSTEM time zone.
TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntry payCalendarEntry, Calendar payCalendar) Defaults to using SYSTEM time zone.
TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntry payCalendarEntry, Calendar payCalendar, boolean useUserTimeZone) Provides the option to refer to the time zone adjusted time for the current user.
TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntry payCalendarEntry, Calendar payCalendar, boolean useUserTimeZone, org.joda.time.DateTimeZone userTimeZone)
TkTimeBlockAggregate(List<TimeBlock> timeBlocks, CalendarEntry payCalendarEntry, Calendar payCalendar, boolean useUserTimeZone, List<org.joda.time.Interval> dayIntervals)
TkTimeBlockAggregate(List<TimeBlock> timeBlocks, List<LeaveBlock> leaveBlocks, CalendarEntry payCalendarEntry) Defaults to using SYSTEM time zone.
TkTimeBlockAggregate(List<TimeBlock> timeBlocks, List<LeaveBlock> leaveBlocks, CalendarEntry payCalendarEntry, Calendar payCalendar) Defaults to using SYSTEM time zone.
TkTimeBlockAggregate(List<TimeBlock> timeBlocks, List<LeaveBlock> leaveBlocks, CalendarEntry 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, CalendarEntry payCalendarEntry, Calendar payCalendar, boolean useUserTimeZone, List<org.joda.time.Interval> dayIntervals)

Method Summary

Methods

Modifier and Type	Method and Description
static TkTimeBlockAggregate	combineTimeAndLeaveAggregates(TkTimeBlockAggregate tbAggregate, LeaveBlockAggregate lbAggregate)
List<List<LeaveBlock>>	getDayLeaveBlockList() The list of day LeaveBlock objects associated with the TkTimeBlockAggregate
List<List<TimeBlock>>	getDayTimeBlockList() The list of day TimeBlock objects associated with the TkTimeBlockAggregate
List<LeaveBlock>	getFlattenedLeaveBlockList() The list of LeaveBlock objects associated with the TkTimeBlockAggregate
List<TimeBlock>	getFlattenedTimeBlockList() The list of TimeBlock objects associated with the TkTimeBlockAggregate
List<FlsaWeek>	getFlsaWeeks(org.joda.time.DateTimeZone zone, int flsaDayConstant, boolean isFlsaDayPassed) 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) TODO: Put a better comment The list of flsa weeks associated with the TkTimeBlockAggregate
Calendar	getPayCalendar() The Calendar object associated with the TkTimeBlockAggregate
CalendarEntry	getPayCalendarEntry() The CalendarEntry object associated with the TkTimeBlockAggregate
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() The number of aggregated weeks associated with the TkTimeBlockAggregate
void	setDayTimeBlockList(List<List<TimeBlock>> dayTimeBlockList)
void	setPayCalendar(Calendar payCalendar)
void	setPayCalendarEntry(CalendarEntry 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,
                    CalendarEntry payCalendarEntry)

Defaults to using SYSTEM time zone.

Parameters:

timeBlocks -

payCalendarEntry -

TkTimeBlockAggregate

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

Defaults to using SYSTEM time zone.

Parameters:

timeBlocks -

payCalendarEntry -

payCalendar -

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                    CalendarEntry 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,
                    CalendarEntry payCalendarEntry,
                    Calendar payCalendar,
                    boolean useUserTimeZone,
                    org.joda.time.DateTimeZone userTimeZone)

TkTimeBlockAggregate

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

TkTimeBlockAggregate

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

Defaults to using SYSTEM time zone.

Parameters:

timeBlocks -

leaveBlocks -

payCalendarEntry -

TkTimeBlockAggregate

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

Defaults to using SYSTEM time zone.

Parameters:

timeBlocks -

leaveBlocks -

payCalendarEntry -

payCalendar -

TkTimeBlockAggregate

public TkTimeBlockAggregate(List<TimeBlock> timeBlocks,
                    List<LeaveBlock> leaveBlocks,
                    CalendarEntry 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,
                    CalendarEntry payCalendarEntry,
                    Calendar payCalendar,
                    boolean useUserTimeZone,
                    List<org.joda.time.Interval> dayIntervals)

Method Detail

getFlattenedTimeBlockList

public List<TimeBlock> getFlattenedTimeBlockList()

Description copied from interface: TkTimeBlockAggregateContract

The list of TimeBlock objects associated with the TkTimeBlockAggregate

the list of flattened time blocks of a TkTimeBlockAggregate

Specified by:

getFlattenedTimeBlockList in interface TkTimeBlockAggregateContract

Returns:

the list of flattened time blocks for TkTimeBlockAggregate

getFlattenedLeaveBlockList

public List<LeaveBlock> getFlattenedLeaveBlockList()

Description copied from interface: TkTimeBlockAggregateContract

The list of LeaveBlock objects associated with the TkTimeBlockAggregate

the list of flattened leave blocks of a TkTimeBlockAggregate

Specified by:

getFlattenedLeaveBlockList in interface TkTimeBlockAggregateContract

Returns:

the list of flattened leave blocks for TkTimeBlockAggregate

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);

Specified by:

getWeekTimeBlocks in interface TkTimeBlockAggregateContract

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);

Specified by:

getWeekLeaveBlocks in interface TkTimeBlockAggregateContract

Parameters:

week -

Returns:

getFlsaWeeks

public List<FlsaWeek> getFlsaWeeks(org.joda.time.DateTimeZone zone,
                          int flsaDayConstant,
                          boolean isFlsaDayPassed)

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.

Specified by:

getFlsaWeeks in interface TkTimeBlockAggregateContract

Parameters:

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

Returns:

the list of flsa weeks for TkTimeBlockAggregate

getFlsaWeeks

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

Description copied from interface: TkTimeBlockAggregateContract

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

the list of flsa weeks of a TkTimeBlockAggregate

Specified by:

getFlsaWeeks in interface TkTimeBlockAggregateContract

Returns:

the list of flsa weeks for TkTimeBlockAggregate

numberOfAggregatedWeeks

public int numberOfAggregatedWeeks()

Description copied from interface: TkTimeBlockAggregateContract

The number of aggregated weeks associated with the TkTimeBlockAggregate

Specified by:

numberOfAggregatedWeeks in interface TkTimeBlockAggregateContract

Returns:

the total number of weeks that this object represents.

getDayTimeBlockList

public List<List<TimeBlock>> getDayTimeBlockList()

Description copied from interface: TkTimeBlockAggregateContract

The list of day TimeBlock objects associated with the TkTimeBlockAggregate

dayTimeBlockList of a TkTimeBlockAggregate

Specified by:

getDayTimeBlockList in interface TkTimeBlockAggregateContract

Returns:

dayTimeBlockList for TkTimeBlockAggregate

getDayLeaveBlockList

public List<List<LeaveBlock>> getDayLeaveBlockList()

Description copied from interface: TkTimeBlockAggregateContract

The list of day LeaveBlock objects associated with the TkTimeBlockAggregate

dayLeaveBlockList of a TkTimeBlockAggregate

Specified by:

getDayLeaveBlockList in interface TkTimeBlockAggregateContract

Returns:

dayLeaveBlockList for TkTimeBlockAggregate

getPayCalendarEntry

public CalendarEntry getPayCalendarEntry()

Description copied from interface: TkTimeBlockAggregateContract

The CalendarEntry object associated with the TkTimeBlockAggregate

payCalendarEntry of a TkTimeBlockAggregate

Specified by:

getPayCalendarEntry in interface TkTimeBlockAggregateContract

Returns:

payCalendarEntry for TkTimeBlockAggregate

setPayCalendarEntry

public void setPayCalendarEntry(CalendarEntry payCalendarEntry)

getPayCalendar

public Calendar getPayCalendar()

Description copied from interface: TkTimeBlockAggregateContract

The Calendar object associated with the TkTimeBlockAggregate

payCalendar of a TkTimeBlockAggregate

Specified by:

getPayCalendar in interface TkTimeBlockAggregateContract

Returns:

payCalendar for TkTimeBlockAggregate

setPayCalendar

public void setPayCalendar(Calendar payCalendar)

setDayTimeBlockList

public void setDayTimeBlockList(List<List<TimeBlock>> dayTimeBlockList)

combineTimeAndLeaveAggregates

public static TkTimeBlockAggregate combineTimeAndLeaveAggregates(TkTimeBlockAggregate tbAggregate,
                                                 LeaveBlockAggregate lbAggregate)