Package overit.geocallapp.wfm.orchestrator.scheduling.bl.activityassignment.task

Class BTWorkShiftTourDataCalculator

java.lang.Object

overit.geocall.bl.BusinessTask<ResourceWorkShiftTourCalculationEvent>

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

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

overit.geocallapp.wfm.orchestrator.scheduling.bl.activityassignment.task.BTWorkShiftTourDataCalculator

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(ResourceWorkShiftTourCalculationEvent.class)
public class BTWorkShiftTourDataCalculator
extends ValidPermissionBusinessTask<ResourceWorkShiftTourCalculationEvent>

Business task in order to schedule an activity to a resource

Since:

17.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected SchedulingTeamResource	resource
protected Date	startWorkingTime
protected Long	transferTimeType

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTWorkShiftTourDataCalculator()

Method Summary

Modifier and Type	Method	Description
protected void	calculateTourInformation(BOResourceWorkShiftTour tourData, PoolKit poolKit)	This method calculates tour information for a resource's work shift.
protected void	checkTourTime(Date tourEndDate, PoolKit poolKit)	Checks if the tour time of the resource is contained into the resource workshift time.
protected void	defineStartWorkingTime(PoolKit poolKit)	Return the start working time of the resource
protected void	elaborateFirstScheduling(BOResourceWorkShiftTour tourData, BOScheduling firstScheduling)	Calculate the tour information related to the first scheduling
protected void	elaborateNextScheduling(BOResourceWorkShiftTour tourData, BOScheduling nextScheduling)	Calculate the tour information adding a new scheduling to the tour
protected void	execute(ResourceWorkShiftTourCalculationEvent event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected SchedulingIntegrationService	getIntegrationService(PoolKit poolKit)
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected void	loadRequiredEntities(PoolKit poolKit)

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

Field Details

resource

protected SchedulingTeamResource resource

transferTimeType

protected Long transferTimeType

startWorkingTime

protected Date startWorkingTime

Constructor Details

BTWorkShiftTourDataCalculator

public BTWorkShiftTourDataCalculator()

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(ResourceWorkShiftTourCalculationEvent event,
 PoolKit poolKit)
                throws DAException,
DAValidateException

Description copied from class: ValidExecutionBusinessTask

Executes the actual business logic after validation has passed.

Specified by:

execute in class ValidExecutionBusinessTask<ResourceWorkShiftTourCalculationEvent>

Parameters:

event - the input event to process

poolKit - the PoolKit

Throws:

DAException - if a data access error occurs during execution

DAValidateException - if validation fails during execution

loadRequiredEntities

protected void loadRequiredEntities(PoolKit poolKit)
                             throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

getIntegrationService

protected SchedulingIntegrationService getIntegrationService(PoolKit poolKit)
                                                      throws DAValidateException

Throws:

DAValidateException

defineStartWorkingTime

protected void defineStartWorkingTime(PoolKit poolKit)
                               throws DAValidateException,
DAException

Return the start working time of the resource

Throws:

DAValidateException

DAException

calculateTourInformation

protected void calculateTourInformation(BOResourceWorkShiftTour tourData,
 PoolKit poolKit)
                                 throws DAValidateException,
DAException

This method calculates tour information for a resource's work shift. It iterates through the resource's work shift schedulings to find the first non-cancelled scheduling. Once found, it uses it to elaborate the tour information of first scheduling and next scheduling. Finally, it checks the tour time.

Parameters:

tourData - The BOResourceWorkShiftTour object to store the calculated tour information.

poolKit - The PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If there is a data access error.

elaborateFirstScheduling

protected void elaborateFirstScheduling(BOResourceWorkShiftTour tourData,
 BOScheduling firstScheduling)

Calculate the tour information related to the first scheduling

elaborateNextScheduling

protected void elaborateNextScheduling(BOResourceWorkShiftTour tourData,
 BOScheduling nextScheduling)

Calculate the tour information adding a new scheduling to the tour

checkTourTime

protected void checkTourTime(Date tourEndDate,
 PoolKit poolKit)
                      throws DAValidateException,
DAException

Checks if the tour time of the resource is contained into the resource workshift time.

Parameters:

tourEndDate - the end time of the tour

poolKit -

Throws:

DAValidateException

DAException