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

Class BTSchedulingOnInterventionOutcomeNotification

java.lang.Object

overit.geocall.bl.BusinessTask<InterventionOutcomeNotificationEvent>

overit.geocallapp.wfm.orchestrator.scheduling.bl.outcome.task.BTSchedulingOnInterventionOutcomeNotification

All Implemented Interfaces:

Serializable, Tool

@Event(InterventionOutcomeNotificationEvent.class)
public class BTSchedulingOnInterventionOutcomeNotification
extends BusinessTask<InterventionOutcomeNotificationEvent>

Business task that react to the update of an intervention outcome.
When the InterventionOutcomeNotificationEvent is launched the BT notices the call, updates the BOAgenda and the BOAppointment related to the notified intervention outcome and eventually cancels all the future schedulings on this intervention.

Since:

18.0

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTSchedulingOnInterventionOutcomeNotification()

Method Summary

Modifier and Type	Method	Description
protected void	arrivalOnSiteAgenda(BOAgenda agenda, PoolKit poolKit)	Arrival at the site an agenda by updating its status to BOAgendaStatus.Values.IN_EXECUTION and launching an AgendaUpdateEvent.
protected void	body(InterventionOutcomeNotificationEvent event, PoolKit poolKit)	If the notification is an update for an intervention outcome, it updates the related agenda and appointment and eventually cancels all the future schedulings on the notified intervention.
protected void	cancelFutureSchedulings(Long workOrderOperation, Date limitDate, PoolKit poolKit)	Cancels all the future schedulings related to the intervention's work order operation.
protected void	deleteEmptyAgendaResource(Set<Long> agendaIds, Set<Long> currentAssigneesIds, PoolKit poolKit)	Deletes empty agenda resources based on the given agenda ids, current assignees ids by calling EmptyInterventionResourceDeleteEvent
protected Long	getAppointmentStatus(Long outcomeType, boolean isLastAppointment)	Returns the calculated next appointment status.
protected SchedulingIntegrationService	getIntegrationService(PoolKit poolKit)	Returns the integration service.
protected List<BOScheduling>	loadFutureCancellableSchedulings(Long workOrderOperation, Date followingSlotLimitDate, PoolKit poolKit)	Loads all the future schedulings related to the intervention's work order operation.
protected void	startAgenda(BOAgenda agenda, PoolKit poolKit)	Save agenda by launching an AgendaUpdateEvent.
protected void	submitAgenda(InterventionOutcomeNotificationInput input, PoolKit poolKit)	Submits the agenda based on the given InterventionOutcomeNotificationInput.
protected void	takeInChargeAppointment(InterventionOutcomeNotificationInput input, PoolKit poolKit)	Takes in charge the appointment associated with the InterventionOutcomeNotificationInput 's appointment.
protected void	updateAgenda(InterventionOutcomeNotificationInput input, PoolKit poolKit)	Updates the agenda related to the notified intervention.
protected void	updateAppointment(Long outcomeType, Long appointmentId, boolean lastAppointment, PoolKit poolKit)	Update appointment related to the notified intervention.

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

BTSchedulingOnInterventionOutcomeNotification

public BTSchedulingOnInterventionOutcomeNotification()

Method Details

body

protected void body(InterventionOutcomeNotificationEvent event,
 PoolKit poolKit)
             throws DAException,
DAValidateException

If the notification is an update for an intervention outcome, it updates the related agenda and appointment and eventually cancels all the future schedulings on the notified intervention. If the notification is a submit the task will change the status of the agenda to submit. If the notification is a take in charge the task will take in charge the agenda, take in charge the appointment and if the property isEmptyAgendaResourceDeletionEnabled is true it will delete the empty agenda resource records related to the agenda by calling the EmptyInterventionResourceDeleteEvent

Specified by:

body in class BusinessTask<InterventionOutcomeNotificationEvent>

Parameters:

event - the InterventionOutcomeNotificationEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

updateAgenda

protected void updateAgenda(InterventionOutcomeNotificationInput input,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Updates the agenda related to the notified intervention.

Parameters:

input - the InterventionOutcomeNotificationInput

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateAppointment

protected void updateAppointment(Long outcomeType,
 Long appointmentId,
 boolean lastAppointment,
 PoolKit poolKit)
                          throws DAValidateException,
DAException

Update appointment related to the notified intervention.

Parameters:

outcomeType - the outcome type

appointmentId - the appointment id

lastAppointment - is this the last appointment

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getAppointmentStatus

protected Long getAppointmentStatus(Long outcomeType,
 boolean isLastAppointment)

Returns the calculated next appointment status.

Parameters:

outcomeType - the outcome type

isLastAppointment - is this the last appointment

Returns:

the calculated appointment status

cancelFutureSchedulings

protected void cancelFutureSchedulings(Long workOrderOperation,
 Date limitDate,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Cancels all the future schedulings related to the intervention's work order operation.

Parameters:

workOrderOperation - the work order operation

limitDate - the limit date

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadFutureCancellableSchedulings

protected List<BOScheduling> loadFutureCancellableSchedulings(Long workOrderOperation,
 Date followingSlotLimitDate,
 PoolKit poolKit)
                                                       throws DAValidateException,
DAException

Loads all the future schedulings related to the intervention's work order operation.

Parameters:

workOrderOperation - the work order operation

followingSlotLimitDate - the following slot limit date

poolKit - the PoolKit

Returns:

a list of BO scheduling elements of type BOScheduling

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getIntegrationService

protected SchedulingIntegrationService getIntegrationService(PoolKit poolKit)
                                                      throws DAValidateException

Returns the integration service.

Parameters:

poolKit - the PoolKit

Returns:

the integration service

Throws:

DAValidateException - the DA validate exception

takeInChargeAppointment

protected void takeInChargeAppointment(InterventionOutcomeNotificationInput input,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Takes in charge the appointment associated with the InterventionOutcomeNotificationInput 's appointment. The appointment status will be set to BOAppointmentStatus.Values.PLANNED only if it is still BOAppointmentStatus.Values.OPEN.

Parameters:

input - The input bean for the InterventionOutcomeNotificationEvent.

poolKit - the PoolKit

Throws:

DAValidateException - If there is an issue with data validation.

DAException - If there is an error during the data access operation.

submitAgenda

protected void submitAgenda(InterventionOutcomeNotificationInput input,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Submits the agenda based on the given InterventionOutcomeNotificationInput.

Parameters:

input - the InterventionOutcomeNotificationInput object

poolKit - the PoolKit

Throws:

DAValidateException - if there is an issue with data validation

DAException - if there is an error during the data access operation

deleteEmptyAgendaResource

protected void deleteEmptyAgendaResource(Set<Long> agendaIds,
 Set<Long> currentAssigneesIds,
 PoolKit poolKit)
                                  throws DAValidateException,
DAException

Deletes empty agenda resources based on the given agenda ids, current assignees ids by calling EmptyInterventionResourceDeleteEvent

Parameters:

agendaIds - the set of BOAgenda's ids

currentAssigneesIds - the set of current assignees ids

poolKit - The PoolKit

Throws:

DAValidateException - if there is an issue with data validation

DAException - if there is an error during the data access operation

arrivalOnSiteAgenda

protected void arrivalOnSiteAgenda(BOAgenda agenda,
 PoolKit poolKit)
                            throws DAException,
DAValidateException

Arrival at the site an agenda by updating its status to BOAgendaStatus.Values.IN_EXECUTION and launching an AgendaUpdateEvent.

Parameters:

agenda - The agenda to be arrival at the site

poolKit - The PoolKit

Throws:

DAException - If there is an error during the data access operation

DAValidateException - If there is an issue with data validation

startAgenda

protected void startAgenda(BOAgenda agenda,
 PoolKit poolKit)
                    throws DAException,
DAValidateException

Save agenda by launching an AgendaUpdateEvent.

Parameters:

agenda - The BOAgenda

poolKit - The PoolKit

Throws:

DAException - If there is an error during the data access operation

DAValidateException - If there is an issue with data validation