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

Class BTBaseActivityManualAssignment<T extends ActivityManualAssignmentInput>

java.lang.Object

overit.geocall.bl.BusinessTask<SimpleBusinessEvent<T,ActivityManualAssignmentOutput>>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask<SimpleBusinessEvent<T,ActivityManualAssignmentOutput>>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask<SimpleBusinessEvent<T,ActivityManualAssignmentOutput>>

overit.geocallapp.wfm.orchestrator.scheduling.bl.activityassignment.task.BTBaseActivityManualAssignment<T>

All Implemented Interfaces:

Serializable, Tool, ValidExecution

Direct Known Subclasses:

BTActivityManualAssignment, BTActivityManualTeamAssignment

public abstract class BTBaseActivityManualAssignment<T extends ActivityManualAssignmentInput>
extends ValidPermissionBusinessTask<SimpleBusinessEvent<T,ActivityManualAssignmentOutput>>

Business task in order to schedule an activity to a resource.
Error Code:

• Codes.ManualScheduling.STATUS_NOT_ALLOWED
• Codes.ManualScheduling.ACTIVITY_DATE_BLOCKED
• Codes.ManualScheduling.WRONG_APPOINTMENT_DATE
• Codes.ManualScheduling.APPOINTMENT_ALREADY_DEFINED
• Codes.ManualScheduling.INVALID_ACTIVITY_COORDINATES
• Codes.ManualScheduling.CANNOT_DEDUCE_DEPARTURE_ADDRESS
• Codes.ManualScheduling.CANNOT_DEDUCE_ARRIVAL_ADDRESS
• Codes.ManualScheduling.INVALID_ARRIVAL_ADDRESS_COORDINATES
• Codes.ManualScheduling.INVALID_DEPARTURE_ADDRESS_COORDINATES
• Codes.ManualScheduling.WORKSHIFT_TIME_EXCEEDED
• Codes.ManualScheduling.ACTION_NOT_ALLOWED_ON_PASSED_DAYS
• Codes.ManualScheduling.ACTION_NOT_POSSIBLE_ON_LOCKED_DAYS
• Codes.ManualScheduling.OPERATION_IS_BOOKING
• Codes.ManualScheduling.RESOURCE_UNAVAILABLE
• Codes.ManualScheduling.ACTIVITY_SCHEDULING_MODE_NOT_VALID
• Codes.ManualScheduling.OPERATION_NOT_ALLOWED_FROM_PROJECT
• Codes.ManualScheduling.WORKSHIFT_END_TIME_EXCEEDED
• Codes.ManualScheduling.WORKSHIFT_OVERTIME_TIME_EXCEEDED
• Codes.ManualScheduling.WORKORDER_BY_ORDER

Since:

18.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected T	eventInput
protected ActivityManualAssignmentOutput	output

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTBaseActivityManualAssignment()

Method Summary

Modifier and Type	Method	Description
protected void	alignAgenda(PoolKit poolKit)	Method that calls the align agenda task, this task will do some checks and modify values related to the agendas of the scheduling.
protected abstract void	assignActivity(PoolKit poolKit)
protected void	buildOutput()	Builds the response object of the paste task
protected void	calculateMissingSkills(PoolKit poolKit)	Calculates the resource/team missing skills for the current work order operation.
protected void	calculateTimeAndDistanceInformation(SchedulingTeamResource resource, PoolKit poolKit)	Calculates the time and distance values for the current scheduling.
protected void	checkActivity(PoolKit poolKit)	Checks the status of the work-order operation before start the scheduling process.
protected void	checkActivityBlockDate()	Check if there is an appointment slot defined for the activity, and returns an error if there isn't a time intersection between this slot and the resource shift.
protected void	checkBookingDate()	Checks if the appointment dates are valid for the work shift.
protected abstract void	checkCrewShell(PoolKit poolKit)
protected void	checkFreezingDay(PoolKit poolKit)	Check if the activity can be pasted evaluating the freezing days defined in the operation center.
protected void	checkScheduledTimeOnWorkshift(SchedulingTeamResource resource, PoolKit poolKit)	Checks if the pasted activity is contained in the work shift time (considering also the overtime).
protected void	checkSchedulingsOfAgendas(Set<Long> agendas, PoolKit poolKit)	Check if the activity is already planned in the current appointment.
protected BOAgenda	createNewAgenda(PoolKit poolKit)	Create a new record on Agenda table for the current appointment.
protected void	execute(SimpleBusinessEvent<T,ActivityManualAssignmentOutput> event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected List<BOScheduling>	getAllResourcesSchedulings()	Saves the initial list of schedulings of the agenda in order to call the procedure that replace the trigger
ManualAssignmentContext	getContext()
protected SchedulingIntegrationService	getIntegrationService(PoolKit poolKit)
protected Long	getInterventionDuration()	Returns the activity duration.
protected SchedulingLock	getLock()
protected abstract Long	getPlanningAction()
protected void	initialChecks(PoolKit poolKit)	Initial checks that evaluate if the operations is assignable to a resource.
protected void	initializeContext(PoolKit poolKit)	Initialize the context object that will store all the data and configurations of the task.
protected Long	insertBasicScheduling(SchedulingTeamResource resource, PoolKit poolKit)	Insert the scheduling record for the activity.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected void	launchCompleteManualActionEvent(PoolKit poolKit)	Launch SchedulingNotificationEvent to notify that the scheduling action is completed.
protected void	launchSchedulingCheckEvent(SchedulingTeamResource resource, PoolKit poolKit)	Event for notify that a new scheduling has been just created.
protected abstract SchedulingTeam	loadTeam(PoolKit poolKit)	Loads the team on which the activity will be assigned
protected void	loadWorkShiftDays(PoolKit poolKit)	Retrieves the work shift days for the specified workShiftTimeLine.
protected void	notifyActivityScheduled(SchedulingTeamResource resource, PoolKit poolKit)	Notify that an activity has been scheduled.
protected void	notifyInsert(BOAppointment appointment, PoolKit poolKit)
protected void	prepareTeam(PoolKit poolKit)	Loads the team and execute some checks on it.
protected void	reloadSchedulings(SchedulingTeamResource resource, Long newSchedulingId)	Reloads the schedulings for a specified SchedulingTeamResource
protected void	retrieveAgenda(PoolKit poolKit)	Retrieve the agenda for the appointment.
protected void	retrieveAppointment(PoolKit poolKit)	Retrieve the appointment for the assignment.
protected void	saveInitialSchedulings()	Saves the initial list of schedulings of the agenda in order to call the procedure that replace the trigger
protected void	savePlanningHistory(PoolKit poolKit)	Launch PlanningActionHistorySaveEvent to save a planning action history.
void	setContext(ManualAssignmentContext context)
protected void	updateNextsSchedulingsOrder(SchedulingTeamResource resource)	Update the execution order on all the schedulings after the current.
protected void	updateParentScheduling()	Update the parent scheduling filed for the current scheduling.
protected void	updatePreviousNextSchedulingCoordinatesPath(SchedulingTeamResource resource)	Aligns previous and next scheduling with the new time-distance values calculated on the current scheduling.
protected void	updateSchedulings(PoolKit poolKit)	Save all the schedulings of the work shifts.
protected void	updateStatus(PoolKit poolKit)	Method that calls UpdateStatusManualSchedulingEvent and updates the status of the appointment, agenda, work order and operation entities related to the scheduling.
protected void	updateWorkshiftTourData(SchedulingTeamResource resource, PoolKit poolKit)	Calculates the new tour data for the current work shift and updates all the schedulings.
protected void	validateEventInput()

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

eventInput

protected T extends ActivityManualAssignmentInput eventInput

output

protected ActivityManualAssignmentOutput output

Constructor Details

BTBaseActivityManualAssignment

public BTBaseActivityManualAssignment()

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(SimpleBusinessEvent<T,ActivityManualAssignmentOutput> 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<SimpleBusinessEvent<T extends ActivityManualAssignmentInput,ActivityManualAssignmentOutput>>

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

getLock

protected SchedulingLock getLock()
                          throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

validateEventInput

protected void validateEventInput()

initializeContext

protected void initializeContext(PoolKit poolKit)
                          throws DAValidateException,
DAException

Initialize the context object that will store all the data and configurations of the task.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getIntegrationService

protected SchedulingIntegrationService getIntegrationService(PoolKit poolKit)
                                                      throws DAValidateException

Throws:

DAValidateException

getContext

public ManualAssignmentContext getContext()

setContext

public void setContext(ManualAssignmentContext context)

loadWorkShiftDays

protected void loadWorkShiftDays(PoolKit poolKit)
                          throws DAValidateException,
DAException

Retrieves the work shift days for the specified workShiftTimeLine.

Parameters:

poolKit - The PoolKit

Throws:

DAValidateException - If there is an error with the validation process.

DAException - If there is an error while retrieving work shift timeline or setting work shift days.

prepareTeam

protected void prepareTeam(PoolKit poolKit)
                    throws DAValidateException,
DAException

Loads the team and execute some checks on it.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException

DAException

loadTeam

protected abstract SchedulingTeam loadTeam(PoolKit poolKit)
                                    throws DAValidateException,
DAException

Loads the team on which the activity will be assigned

Parameters:

poolKit - the PoolKit

Returns:

Throws:

DAValidateException

DAException

initialChecks

protected void initialChecks(PoolKit poolKit)
                      throws DAValidateException,
DAException

Initial checks that evaluate if the operations is assignable to a resource.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkCrewShell

protected abstract void checkCrewShell(PoolKit poolKit)
                                throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

checkActivity

protected void checkActivity(PoolKit poolKit)
                      throws DAValidateException,
DAException

Checks the status of the work-order operation before start the scheduling process.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkFreezingDay

protected void checkFreezingDay(PoolKit poolKit)
                         throws DAValidateException,
DAException

Check if the activity can be pasted evaluating the freezing days defined in the operation center.
Activities cannot be assigned in the past or in freezing days.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkActivityBlockDate

protected void checkActivityBlockDate()
                               throws DAValidateException

Check if there is an appointment slot defined for the activity, and returns an error if there isn't
a time intersection between this slot and the resource shift.

Throws:

DAValidateException

checkBookingDate

protected void checkBookingDate()
                         throws DAValidateException

Checks if the appointment dates are valid for the work shift.

Throws:

DAValidateException

retrieveAppointment

protected void retrieveAppointment(PoolKit poolKit)
                            throws DAValidateException,
DAException

Retrieve the appointment for the assignment.
This is the logic of the retrieving process: - if exists an appointment in open status, use that appointment cleaning the old data;
- else if exists any appointment not in status (cancelled/closed), throw exception;
- else create a new appointment.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException

DAException

notifyInsert

protected void notifyInsert(BOAppointment appointment,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

retrieveAgenda

protected void retrieveAgenda(PoolKit poolKit)
                       throws DAValidateException,
DAException

Retrieve the agenda for the appointment.
This is the logic of the retrieving process: - if exists one or more agenda in open status for the appointment, take one random;
- else if exists any agenda not in status cancelled/closed, throw exception;
- else create a new agenda.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - if the retrieved agenda fails validation

DAException - if an exception occurs during the retrieval process

checkSchedulingsOfAgendas

protected void checkSchedulingsOfAgendas(Set<Long> agendas,
 PoolKit poolKit)
                                  throws DAValidateException,
DAException

Check if the activity is already planned in the current appointment.

Parameters:

agendas - the set of agendas of the appointment

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

createNewAgenda

protected BOAgenda createNewAgenda(PoolKit poolKit)
                            throws DAValidateException,
DAException

Create a new record on Agenda table for the current appointment.

Parameters:

poolKit - the PoolKit

Returns:

the new agenda record

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

assignActivity

protected abstract void assignActivity(PoolKit poolKit)
                                throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

insertBasicScheduling

protected Long insertBasicScheduling(SchedulingTeamResource resource,
 PoolKit poolKit)
                              throws DAValidateException,
DAException

Insert the scheduling record for the activity.

Parameters:

poolKit - the PoolKit

Returns:

the id of the new scheduling

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getPlanningAction

protected abstract Long getPlanningAction()

saveInitialSchedulings

protected void saveInitialSchedulings()

Saves the initial list of schedulings of the agenda in order to call the procedure that replace the trigger

getAllResourcesSchedulings

protected List<BOScheduling> getAllResourcesSchedulings()

Saves the initial list of schedulings of the agenda in order to call the procedure that replace the trigger

getInterventionDuration

protected Long getInterventionDuration()

Returns the activity duration.

updatePreviousNextSchedulingCoordinatesPath

protected void updatePreviousNextSchedulingCoordinatesPath(SchedulingTeamResource resource)

Aligns previous and next scheduling with the new time-distance values calculated on the current scheduling.

updateSchedulings

protected void updateSchedulings(PoolKit poolKit)
                          throws DAValidateException,
DAException

Save all the schedulings of the work shifts.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateStatus

protected void updateStatus(PoolKit poolKit)
                     throws DAValidateException,
DAException

Method that calls UpdateStatusManualSchedulingEvent and updates the status of the appointment, agenda, work order and operation entities related to the scheduling.
If required, the agenda is validated also the crew shell schedulings.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

reloadSchedulings

protected void reloadSchedulings(SchedulingTeamResource resource,
 Long newSchedulingId)
                          throws DAValidateException,
DAException

Reloads the schedulings for a specified SchedulingTeamResource

Parameters:

resource - the SchedulingTeamResource to reload the schedulings for

newSchedulingId - the ID of the new scheduling to set as the current scheduling position

Throws:

DAValidateException - when validation fails

DAException - when an error occurs during the reloading process

updateParentScheduling

protected void updateParentScheduling()

Update the parent scheduling filed for the current scheduling.

notifyActivityScheduled

protected void notifyActivityScheduled(SchedulingTeamResource resource,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Notify that an activity has been scheduled. Here we launch this event for execute the planning actions.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

alignAgenda

protected void alignAgenda(PoolKit poolKit)
                    throws DAException,
DAValidateException

Method that calls the align agenda task, this task will do some checks and modify values related to the agendas of the scheduling. This is the call to the new business task that is replacing the trigger AGGIORNAAAGENDA.

Parameters:

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

calculateTimeAndDistanceInformation

protected void calculateTimeAndDistanceInformation(SchedulingTeamResource resource,
 PoolKit poolKit)
                                            throws DAValidateException,
DAException

Calculates the time and distance values for the current scheduling. This calculation affects only the in-memory BOScheduling object of the current scheduling.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

savePlanningHistory

protected void savePlanningHistory(PoolKit poolKit)
                            throws DAValidateException,
DAException

Launch PlanningActionHistorySaveEvent to save a planning action history.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

calculateMissingSkills

protected void calculateMissingSkills(PoolKit poolKit)
                               throws DAValidateException,
DAException

Calculates the resource/team missing skills for the current work order operation.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateNextsSchedulingsOrder

protected void updateNextsSchedulingsOrder(SchedulingTeamResource resource)

Update the execution order on all the schedulings after the current.

updateWorkshiftTourData

protected void updateWorkshiftTourData(SchedulingTeamResource resource,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Calculates the new tour data for the current work shift and updates all the schedulings.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

launchCompleteManualActionEvent

protected void launchCompleteManualActionEvent(PoolKit poolKit)
                                        throws DAException,
DAValidateException

Launch SchedulingNotificationEvent to notify that the scheduling action is completed.

Parameters:

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

launchSchedulingCheckEvent

protected void launchSchedulingCheckEvent(SchedulingTeamResource resource,
 PoolKit poolKit)
                                   throws DAValidateException,
DAException

Event for notify that a new scheduling has been just created. This event execute some check (ex: multistage violations, permits, ..) and raise exception if there is a blocking error.

Parameters:

poolKit - the pool kit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

buildOutput

protected void buildOutput()

Builds the response object of the paste task

checkScheduledTimeOnWorkshift

protected void checkScheduledTimeOnWorkshift(SchedulingTeamResource resource,
 PoolKit poolKit)
                                      throws DAValidateException,
DAException

Checks if the pasted activity is contained in the work shift time (considering also the overtime).

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception