Package overit.geocallapp.wfm.core.bl.timesheet.task

Class BTTimesheetShiftCalculation

java.lang.Object

overit.geocall.bl.BusinessTask<TimesheetShiftCalculationEvent>

overit.geocallapp.wfm.core.bl.timesheet.task.BTTimesheet<TimesheetShiftCalculationEvent>

overit.geocallapp.wfm.core.bl.timesheet.task.BTTimesheetShiftCalculation

All Implemented Interfaces:

Serializable, Tool

@Event(TimesheetShiftCalculationEvent.class)
public class BTTimesheetShiftCalculation
extends BTTimesheet<TimesheetShiftCalculationEvent>

Business task in order to calculate all the shifts linked to a timesheet task, which can be both BOWorkShift or BOOnCallShift.
When the TimesheetShiftCalculationEvent is launched the BT notices the call and calculates all the shifts basing on the event's input.

Since:

9.2

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTTimesheetShiftCalculation()

Method Summary

Modifier and Type	Method	Description
protected TimesheetShiftCalculationOutput	buildInterval(List<BOWorkShift> workShifts, List<BOOnCallShift> onCallShifts, Date startDate, Date endDate)	Builds an interval linked to a shift or to an on call shift.
protected TimesheetShiftCalculationOutput	buildInterval(overit.geocallapp.wfm.util.timeline.TimeLineRange range)	Builds an interval linked to a shift or to an on call shift.
protected void	completeShiftIds(List<TimesheetShiftCalculationOutput> intervals, Long user, Date timesheetStartDate, Date timesheetEndDate, TimesheetTaskEventCache cache, PoolKit poolKit)	Calculates the shift id for intervals that don't have it.
protected void	execute(TimesheetShiftCalculationEvent event, PoolKit poolKit)	Writes the results, i.e a list of TimesheetShiftCalculationOutput into the event journal.
protected List<overit.geocallapp.wfm.util.timeline.TimeLineRange>	getRanges(List<BOWorkShift> workShifts, List<BOOnCallShift> onCallShifts, Long user, Date startDate, Date endDate)	Builds a new timeline with shifts and on call shifts and extracts the ranges.
protected boolean	isTimesheetShift(Long shiftId, Date timesheetStartDate, Date timesheetEndDate, TimesheetTaskEventCache cache, PoolKit poolKit)
protected List<BOOnCallShift>	loadOnCallShifts(Long user, Date startDate, Date endDate, PoolKit poolKit)	Loads the on call shifts that overlap the task.
protected List<BOWorkShift>	loadWorkShifts(Long user, Date startDate, Date endDate, PoolKit poolKit)	Loads the work shifts that overlap the task.
protected List<TimesheetShiftCalculationOutput>	mergeAdjacentIntervals(List<TimesheetShiftCalculationOutput> intervals)	Merges adjacent intervals.

Methods inherited from class overit.geocallapp.wfm.core.bl.timesheet.task.BTTimesheet

body, checkTimesheetActivation, throwInactiveTimesheetException

Methods inherited from class overit.geocall.bl.BusinessTask

start, start, startAlone, startInBackground

Methods inherited from class java.lang.Object

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

Constructor Details

BTTimesheetShiftCalculation

public BTTimesheetShiftCalculation()

Method Details

execute

protected void execute(TimesheetShiftCalculationEvent event,
 PoolKit poolKit)
                throws DAException,
DAValidateException

Writes the results, i.e a list of TimesheetShiftCalculationOutput into the event journal.

Specified by:

execute in class BTTimesheet<TimesheetShiftCalculationEvent>

Parameters:

event - the timesheet calculation event

poolKit - the pool kit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadWorkShifts

protected List<BOWorkShift> loadWorkShifts(Long user,
 Date startDate,
 Date endDate,
 PoolKit poolKit)
                                    throws DAValidateException,
DAException

Loads the work shifts that overlap the task.

Parameters:

user - the user id

startDate - the task start date

endDate - the task end date

poolKit - the poolKit

Returns:

the list of work shift that overlap the task

Throws:

DAValidateException

DAException

loadOnCallShifts

protected List<BOOnCallShift> loadOnCallShifts(Long user,
 Date startDate,
 Date endDate,
 PoolKit poolKit)
                                        throws DAValidateException,
DAException

Loads the on call shifts that overlap the task.

Parameters:

user - the user id

startDate - the task start date

endDate - the task end date

poolKit - the poolKit

Returns:

the list of on call shift that overlap the task

Throws:

DAValidateException

DAException

getRanges

protected List<overit.geocallapp.wfm.util.timeline.TimeLineRange> getRanges(List<BOWorkShift> workShifts,
 List<BOOnCallShift> onCallShifts,
 Long user,
 Date startDate,
 Date endDate)

Builds a new timeline with shifts and on call shifts and extracts the ranges.

Parameters:

workShifts - the work shifts related to the task

onCallShifts - the on call shifts related to the task

user - the user id

startDate - the task start date

endDate - the task end date

Returns:

buildInterval

protected TimesheetShiftCalculationOutput buildInterval(overit.geocallapp.wfm.util.timeline.TimeLineRange range)

Builds an interval linked to a shift or to an on call shift.

Parameters:

range - the timeline range

Returns:

a new interval linked to a shift or to an on call shift

buildInterval

protected TimesheetShiftCalculationOutput buildInterval(List<BOWorkShift> workShifts,
 List<BOOnCallShift> onCallShifts,
 Date startDate,
 Date endDate)

Builds an interval linked to a shift or to an on call shift.

Parameters:

workShifts - the work shifts related to the task

onCallShifts - the on call shifts related to the task

startDate - the task start date

endDate - the task end date

Returns:

a new interval linked to a shift or to an on call shift

completeShiftIds

protected void completeShiftIds(List<TimesheetShiftCalculationOutput> intervals,
 Long user,
 Date timesheetStartDate,
 Date timesheetEndDate,
 TimesheetTaskEventCache cache,
 PoolKit poolKit)
                         throws DAValidateException,
DAException

Calculates the shift id for intervals that don't have it.

Parameters:

intervals - the list of intervals

user - the user id

timesheetStartDate - the timesheet start date

timesheetEndDate - the timesheet end date

poolKit - the poolKit

timesheetTaskEventCache - the timesheet task event cache

Throws:

DAValidateException

DAException

isTimesheetShift

protected boolean isTimesheetShift(Long shiftId,
 Date timesheetStartDate,
 Date timesheetEndDate,
 TimesheetTaskEventCache cache,
 PoolKit poolKit)

mergeAdjacentIntervals

protected List<TimesheetShiftCalculationOutput> mergeAdjacentIntervals(List<TimesheetShiftCalculationOutput> intervals)

Merges adjacent intervals.

Parameters:

intervals - the original list of intervals

Returns:

a new list of merged adjacent intervals