Package overit.geocallapp.wfm.calendars.bl.workshift.exception.task

Class BTWorkShiftExceptionTotalsCalculation

java.lang.Object

overit.geocall.bl.BusinessTask<WorkShiftExceptionTotalsCalculationEvent>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask<WorkShiftExceptionTotalsCalculationEvent>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask<WorkShiftExceptionTotalsCalculationEvent>

overit.geocallapp.wfm.calendars.bl.workshift.exception.task.BTWorkShiftExceptionTotalsCalculation

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(WorkShiftExceptionTotalsCalculationEvent.class)
public class BTWorkShiftExceptionTotalsCalculation
extends ValidPermissionBusinessTask<WorkShiftExceptionTotalsCalculationEvent>

Business task which implements some calculation logics related to a BOWorkShiftException.
When the WorkShiftExceptionTotalsCalculationEvent is launched the BT notices the call and does the required logics basing on the event's input.

Since:

17.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask

LOG

Constructor Summary

Constructors

Constructor	Description
BTWorkShiftExceptionTotalsCalculation()

Method Summary

Modifier and Type	Method	Description
protected void	calculateTotalUnavailability(BOWorkShift workShift, PoolKit poolKit)	Calculates the total amount of overlapping breaks and absences during a given BOWorkShift-
protected void	execute(WorkShiftExceptionTotalsCalculationEvent event, PoolKit poolKit)	Implements some logics about the calculation.
protected List<BOWorkShiftException>	getExceptions(List<BOWorkShiftException> shiftExceptions, Long classType, PoolKit poolKit)	Method that filters a list of input work shift exceptions based on the class type.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected List<BOWorkShiftExceptionWorkShift>	loadRelations(BOWorkShift workShift, PoolKit poolKit)
protected void	notifyWorkShift(BOWorkShift workShift, BaseNotificationAction action, PoolKit poolKit)
protected BOWorkShift	searchWorkShift(Long workShiftId, PoolKit poolKit)	Searches the required BOWorkShift.
protected List<BOWorkShiftException>	searchWorkShiftExceptionWorkShift(BOWorkShift workShift, PoolKit poolKit)	Loads absences and extra presences overlapping a given BOWorkShift.
protected void	setStartEndDate(BOWorkShift workShift, TimeLine timeLine)	Method to set the new start and end dates of work shifts based on extra presences and absences.
protected void	updateWorkShift(BOWorkShift workShift, PoolKit poolKit)	Updates the work shift.

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask

checkValidExecution, getException, throwExceptionIfInvalid

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask

body, getEvent

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

BTWorkShiftExceptionTotalsCalculation

public BTWorkShiftExceptionTotalsCalculation()

Method Details

isValidExecution

public boolean isValidExecution()

Description copied from interface: ValidExecution

Determines whether the current state is valid for execution.

Returns:

true if execution is valid, false otherwise

execute

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

Implements some logics about the calculation.

Specified by:

execute in class ValidExecutionBusinessTask<WorkShiftExceptionTotalsCalculationEvent>

Parameters:

event - the WorkShiftExceptionTotalsCalculationEvent

poolKit - the PoolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

searchWorkShift

protected BOWorkShift searchWorkShift(Long workShiftId,
 PoolKit poolKit)
                               throws DAException,
DAValidateException

Searches the required BOWorkShift.

Parameters:

workShiftId - the ID of the required BOWorkShift

poolKit - the PoolKit pool kit

Returns:

the required work shift

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

calculateTotalUnavailability

protected void calculateTotalUnavailability(BOWorkShift workShift,
 PoolKit poolKit)
                                     throws DAException,
DAValidateException

Calculates the total amount of overlapping breaks and absences during a given BOWorkShift-

Parameters:

workShift - the BOWorkShift

poolKit - the PoolKit pool kit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

getExceptions

protected List<BOWorkShiftException> getExceptions(List<BOWorkShiftException> shiftExceptions,
 Long classType,
 PoolKit poolKit)
                                            throws DAValidateException,
DAException

Method that filters a list of input work shift exceptions based on the class type.

Parameters:

shiftExceptions - the list of BOWorkShiftException

classType - the class type id

poolKit - the PoolKit

Returns:

the filtered list of BOWorkShiftException

Throws:

DAValidateException

DAException

searchWorkShiftExceptionWorkShift

protected List<BOWorkShiftException> searchWorkShiftExceptionWorkShift(BOWorkShift workShift,
 PoolKit poolKit)
                                                                throws DAException,
DAValidateException

Loads absences and extra presences overlapping a given BOWorkShift.

Parameters:

workShift - the BOWorkShift

poolKit - the PoolKit pool kit

Returns:

the list of work shift exceptions overlapping a given work shift

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

loadRelations

protected List<BOWorkShiftExceptionWorkShift> loadRelations(BOWorkShift workShift,
 PoolKit poolKit)
                                                     throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

setStartEndDate

protected void setStartEndDate(BOWorkShift workShift,
 TimeLine timeLine)

Method to set the new start and end dates of work shifts based on extra presences and absences.

Parameters:

workShift - the BOWorkShift

timeLine - the TimeLine of the work shift

updateWorkShift

protected void updateWorkShift(BOWorkShift workShift,
 PoolKit poolKit)
                        throws DAException,
DAValidateException

Updates the work shift.

Parameters:

workShift - the BOWorkShift

poolKit - the PoolKit pool kit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

notifyWorkShift

protected void notifyWorkShift(BOWorkShift workShift,
 BaseNotificationAction action,
 PoolKit poolKit)
                        throws DAValidateException,
DAException

Throws:

DAValidateException

DAException