Package overit.geocallapp.wfm.orchestrator.workorders.bl.outcome.intervention.task

Class BTInterventionOutcomeSave

java.lang.Object

overit.geocall.bl.BusinessTask<InterventionOutcomeSaveEvent>

overit.geocallapp.wfm.orchestrator.workorders.bl.outcome.intervention.task.BTInterventionOutcomeSave

All Implemented Interfaces:

Serializable, Tool

@Event(InterventionOutcomeSaveEvent.class)
public class BTInterventionOutcomeSave
extends BusinessTask<InterventionOutcomeSaveEvent>

Business task in order to save an BOInterventionOutcome.
When the InterventionOutcomeSaveEvent is launched the BT notices the call and saves the BOInterventionOutcome basing on the event's input.
The BOInterventionOutcome saving process divide itself into multiple steps:

• validation phase using InterventionOutcomeValidateEvent
• check on the existence of related interventions that are already accounted
• check on the intervention measures to ensure they are all validated
• if the intervention is not already closed, it updates also the related appointment, work order operation and work order
• if the intervention is already closed, only few information are allowed to be updated

Required fields:

• intervention id
• outcome origin
• outcome reason

Error code:

• Codes.InterventionOutcome.ALREDY_ACCOUNTED_INTERVENTION
• Codes.InterventionOutcome.INVALID_WO_OPERATION_STATUS
• Codes.InterventionOutcome.INVALID_STATUS
• Codes.InterventionOutcome.INVALID_OPERATION_TECHNICAL_VALIDAITON

Since:

18.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected BOAppointment	appointment
protected InterventionAggregate	interventionAggregate
protected BOOutcomeReason	outcomeReason
protected BOWorkOrderHeader	workOrder
protected BOWorkOrderOperation	workOrderOperation

Constructor Summary

Constructors

Constructor	Description
BTInterventionOutcomeSave()

Method Summary

Modifier and Type	Method	Description
protected void	body(InterventionOutcomeSaveEvent event, PoolKit poolKit)	Saves the BOInterventionOutcome.
protected void	checkAlreadyAccountedIntervention(List<InterventionAggregate> sameAppointmentIntervention)	Checks if the intervention is related to another already accounted intervention.
protected void	checkMeasures(BOIntervention intervention, PoolKit poolKit)	Validates the measures for the intervention outcome by calling the InterventionMeasureCheckEvent.
protected void	checkMeterReadings(Long reasonTypeId, Long interventionGroup, PoolKit poolKit)	Checks if the meter readings are mandatory for this outcome.
protected boolean	checkTotalOutcomesForWorkOrder(BOWorkOrderHeader workOrder, BOWorkOrderOperation workOrderOperation, PoolKit poolKit)	Checks if the total outcomes for the work order is being respected or not.
protected void	checkWorkOrderOperationStatus()	Checks whether the work order operation status is valid for the intervention outcome saving.
protected Long	getForcedClosureType(BOWorkOrderHeader workOrder, Long outcomeType, BOWorkOrderOperation workOrderOperation, boolean isLastAppointment, PoolKit poolKit)	Returns the forced closure type basing on the outcome data.
protected WorkOrdersIntegrationService	getIntegrationService(PoolKit poolKit)	Returns the integration service.
protected Long	getInterventionGroup(PoolKit poolKit)	Returns the intervention group.
protected Long	getResidualTime(BOWorkOrderOperation workOrderOperation, List<InterventionAggregate> sameAppointmentIntervention, boolean isLastAppointment)	Calculates the work order operation residual time.
protected List<InterventionAggregate>	getSameAppointmentInterventions(PoolKit poolKit)	Returns the all the interventions that have the same appointment of the intervention we are saving.
protected Long	getWorkOrderOperationStatus(BOWorkOrderOperation workOrderOperation, Long outcomeType, PoolKit poolKit)	Returns the calculated work order operation status.
protected void	initialize(InterventionOutcomeSaveInput input, PoolKit poolKit)	Initializes the needed entity for the saving.
protected void	insertInterventionOutcome(boolean isLastAppointment, Long outcomeType, PoolKit poolKit)	Inserts the new intervention outcome.
protected boolean	isLastAppointment(List<InterventionAggregate> sameAppointmentIntervention)	Checks if the intervention appointment is last one for the given work order operation.
protected BOAppointment	loadAppointment(Long appointment, PoolKit poolKit)	Loads the appointment.
protected InterventionAggregate	loadInterventionAggregate(Long id, PoolKit poolKit)	Loads the InterventionAggregate.
protected BOOutcomeReason	loadOutcomeReason(Long outcomeReason, PoolKit poolKit)	Loads the outcome reason from the given id.
protected BOOutcomeReasonType	loadReasonType(Long outcomeReasonType, PoolKit poolKit)	Loads the reason type from the given id.
protected BOWorkOrderHeader	loadWorkOrder(Long workOrder, PoolKit poolKit)	Loads the work order from the given id.
protected BOWorkOrderOperation	loadWorkOrderOperation(Long workOrderOperation, PoolKit poolKit)	Loads the work order operation from the given id.
protected void	notifyInterventionOutcome(InterventionOutcomeNotificationAction action, boolean isLastAppointment, Long outcomeType, Date limitDate, PoolKit poolKit)	Notifies the intervention outcome update.
protected void	recalculateWorkOrderStatus(PoolKit poolKit)	Recalculates the work order status by calling the WorkOrderHeaderStatusRecalculateEvent.
protected List<BOWorkOrderOperation>	searchWorkOrderOperations(PoolKit poolKit)	Searches for the work order operations related to the given work order, sorting them by last outcome date.
protected void	setOutcomeEndDate(Date now)	Sets the outcome end date basing on the intervention.
protected void	setOutcomeStartDate(List<InterventionAggregate> sameAppointmentIntervention, Date now)	Sets the outcome start date basing on the intervention or the previously not yet accounted ones.
protected void	setWorkOrderOperationLastOutcomeData()	Sets the last outcome data on the work order operation.
protected void	setWorkOrderOperationResidualTime(List<InterventionAggregate> sameAppointmentIntervention, boolean isLastAppointment, Long outcomeType)	Sets the work order operation residual time.
protected void	updateInterventionOutcome(PoolKit poolKit)	Updates the current intervention outcome.
protected void	updateValidationStatus(PoolKit poolKit)	Updates the validation status by calling the InterventionOutcomeValidationStatusUpdateEvent and the InterventionOutcomeValidationStatusByRuleUpdateEvent.
protected void	updateWOByOrderInterventions(PoolKit poolKit)	Updates all the intervention that have the current one as parent.
protected void	updateWorkOrder(PoolKit poolKit)	Updates the work order and updates its status.
protected void	updateWorkOrderOperation(boolean isLastAppointment, Long outcomeType, List<InterventionAggregate> sameAppointmentIntervention, PoolKit poolKit)	Updates the work order operation with its status.
protected void	validate(InterventionOutcomeSaveInput input, PoolKit poolKit)	Validates the outcome and the intervention before the saving process.

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

interventionAggregate

protected InterventionAggregate interventionAggregate

appointment

protected BOAppointment appointment

workOrderOperation

protected BOWorkOrderOperation workOrderOperation

workOrder

protected BOWorkOrderHeader workOrder

outcomeReason

protected BOOutcomeReason outcomeReason

Constructor Details

BTInterventionOutcomeSave

public BTInterventionOutcomeSave()

Method Details

body

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

Saves the BOInterventionOutcome.

Specified by:

body in class BusinessTask<InterventionOutcomeSaveEvent>

Parameters:

event - the InterventionOutcomeSaveEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

validate

protected void validate(InterventionOutcomeSaveInput input,
 PoolKit poolKit)
                 throws DAValidateException,
DAException

Validates the outcome and the intervention before the saving process.

Parameters:

input - the InterventionOutcomeSaveInput

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateWOByOrderInterventions

protected void updateWOByOrderInterventions(PoolKit poolKit)
                                     throws DAValidateException,
DAException

Updates all the intervention that have the current one as parent. Used in work order by order management.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

initialize

protected void initialize(InterventionOutcomeSaveInput input,
 PoolKit poolKit)
                   throws DAValidateException,
DAException

Initializes the needed entity for the saving.

Parameters:

input - the InterventionOutcomeSaveInput

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkAlreadyAccountedIntervention

protected void checkAlreadyAccountedIntervention(List<InterventionAggregate> sameAppointmentIntervention)
                                          throws DAValidateException

Checks if the intervention is related to another already accounted intervention.

Parameters:

sameAppointmentIntervention - list of InterventionAggregate

Throws:

DAValidateException - the DA validate exception

getSameAppointmentInterventions

protected List<InterventionAggregate> getSameAppointmentInterventions(PoolKit poolKit)
                                                               throws DAValidateException,
DAException

Returns the all the interventions that have the same appointment of the intervention we are saving.

Parameters:

poolKit - the PoolKit

Returns:

the same appointment interventions

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

setOutcomeStartDate

protected void setOutcomeStartDate(List<InterventionAggregate> sameAppointmentIntervention,
 Date now)

Sets the outcome start date basing on the intervention or the previously not yet accounted ones.

Parameters:

sameAppointmentIntervention - list of InterventionAggregate with the same appointment

now - the now moment expressed as date

setOutcomeEndDate

protected void setOutcomeEndDate(Date now)

Sets the outcome end date basing on the intervention.

Parameters:

now - the now moment expressed as date

checkWorkOrderOperationStatus

protected void checkWorkOrderOperationStatus()
                                      throws DAValidateException

Checks whether the work order operation status is valid for the intervention outcome saving.

Throws:

DAValidateException - the DA validate exception

checkMeterReadings

protected void checkMeterReadings(Long reasonTypeId,
 Long interventionGroup,
 PoolKit poolKit)
                           throws DAValidateException,
DAException

Checks if the meter readings are mandatory for this outcome.

Parameters:

reasonTypeId - the current BOOutcomeReasonType

interventionGroup - the intervention group

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkMeasures

protected void checkMeasures(BOIntervention intervention,
 PoolKit poolKit)
                      throws DAValidateException,
DAException

Validates the measures for the intervention outcome by calling the InterventionMeasureCheckEvent.

Parameters:

intervention - the intervention

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getWorkOrderOperationStatus

protected Long getWorkOrderOperationStatus(BOWorkOrderOperation workOrderOperation,
 Long outcomeType,
 PoolKit poolKit)
                                    throws DAValidateException,
DAException

Returns the calculated work order operation status.

Parameters:

workOrderOperation - the work order operation

outcomeType - the outcome type

poolKit - the PoolKit

Returns:

the work order operation status

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getForcedClosureType

protected Long getForcedClosureType(BOWorkOrderHeader workOrder,
 Long outcomeType,
 BOWorkOrderOperation workOrderOperation,
 boolean isLastAppointment,
 PoolKit poolKit)
                             throws DAValidateException,
DAException

Returns the forced closure type basing on the outcome data.

Parameters:

workOrder - the work order

outcomeType - the outcome type

workOrderOperation - the work order operation

isLastAppointment - is this the last appointment

poolKit - the PoolKit

Returns:

the forced closure type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkTotalOutcomesForWorkOrder

protected boolean checkTotalOutcomesForWorkOrder(BOWorkOrderHeader workOrder,
 BOWorkOrderOperation workOrderOperation,
 PoolKit poolKit)
                                          throws DAValidateException,
DAException

Checks if the total outcomes for the work order is being respected or not.

Parameters:

workOrder - the work order

workOrderOperation - the work order operation

poolKit - the PoolKit

Returns:

true if the outcome count for the work order is respected, false otherwise

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

insertInterventionOutcome

protected void insertInterventionOutcome(boolean isLastAppointment,
 Long outcomeType,
 PoolKit poolKit)
                                  throws DAValidateException,
DAException

Inserts the new intervention outcome. Please note that inserting an intervention outcome translates into updating the AAGENDA db table.

Parameters:

isLastAppointment - is this the last appointment

outcomeType - the outcome type

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateInterventionOutcome

protected void updateInterventionOutcome(PoolKit poolKit)
                                  throws DAValidateException,
DAException

Updates the current intervention outcome.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

notifyInterventionOutcome

protected void notifyInterventionOutcome(InterventionOutcomeNotificationAction action,
 boolean isLastAppointment,
 Long outcomeType,
 Date limitDate,
 PoolKit poolKit)
                                  throws DAValidateException,
DAException

Notifies the intervention outcome update.

Parameters:

action - the action performed on the intervention outcome

isLastAppointment - is this the last appointment

outcomeType - the outcome type

limitDate - the limit date

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateWorkOrder

protected void updateWorkOrder(PoolKit poolKit)
                        throws DAValidateException,
DAException

Updates the work order and updates its status.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

searchWorkOrderOperations

protected List<BOWorkOrderOperation> searchWorkOrderOperations(PoolKit poolKit)
                                                        throws DAValidateException,
DAException

Searches for the work order operations related to the given work order, sorting them by last outcome date.

Parameters:

poolKit - the PoolKit

Returns:

a list of loaded work order operation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

recalculateWorkOrderStatus

protected void recalculateWorkOrderStatus(PoolKit poolKit)
                                   throws DAValidateException,
DAException

Recalculates the work order status by calling the WorkOrderHeaderStatusRecalculateEvent.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

setWorkOrderOperationLastOutcomeData

protected void setWorkOrderOperationLastOutcomeData()

Sets the last outcome data on the work order operation.

updateValidationStatus

protected void updateValidationStatus(PoolKit poolKit)
                               throws DAValidateException,
DAException

Updates the validation status by calling the InterventionOutcomeValidationStatusUpdateEvent and the InterventionOutcomeValidationStatusByRuleUpdateEvent.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateWorkOrderOperation

protected void updateWorkOrderOperation(boolean isLastAppointment,
 Long outcomeType,
 List<InterventionAggregate> sameAppointmentIntervention,
 PoolKit poolKit)
                                 throws DAValidateException,
DAException

Updates the work order operation with its status.

Parameters:

isLastAppointment - is this the last appointment

outcomeType - the outcome type

sameAppointmentIntervention - list of InterventionAggregate with the same appointment

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

setWorkOrderOperationResidualTime

protected void setWorkOrderOperationResidualTime(List<InterventionAggregate> sameAppointmentIntervention,
 boolean isLastAppointment,
 Long outcomeType)

Sets the work order operation residual time.

Parameters:

sameAppointmentIntervention - list of InterventionAggregate

isLastAppointment - the is last appointment

outcomeType - the outcome type

getResidualTime

protected Long getResidualTime(BOWorkOrderOperation workOrderOperation,
 List<InterventionAggregate> sameAppointmentIntervention,
 boolean isLastAppointment)

Calculates the work order operation residual time.

Parameters:

workOrderOperation - the current work order operation

sameAppointmentIntervention - list of InterventionAggregate

isLastAppointment - is this the last appointment

Returns:

the residual time

loadInterventionAggregate

protected InterventionAggregate loadInterventionAggregate(Long id,
 PoolKit poolKit)
                                                   throws DAValidateException,
DAException

Loads the InterventionAggregate.

Parameters:

id - the intervention id

poolKit - the PoolKit

Returns:

the loaded intervention aggregate

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadAppointment

protected BOAppointment loadAppointment(Long appointment,
 PoolKit poolKit)
                                 throws DAValidateException,
DAException

Loads the appointment.

Parameters:

appointment - the appointment

poolKit - the pool PoolKit

Returns:

the loaded appointment

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadWorkOrderOperation

protected BOWorkOrderOperation loadWorkOrderOperation(Long workOrderOperation,
 PoolKit poolKit)
                                               throws DAValidateException,
DAException

Loads the work order operation from the given id.

Parameters:

workOrderOperation - the work order operation id

poolKit - the PoolKit

Returns:

the loaded work order operation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadWorkOrder

protected BOWorkOrderHeader loadWorkOrder(Long workOrder,
 PoolKit poolKit)
                                   throws DAValidateException,
DAException

Loads the work order from the given id.

Parameters:

workOrder - the work order id

poolKit - the PoolKit

Returns:

the loaded work order header

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadOutcomeReason

protected BOOutcomeReason loadOutcomeReason(Long outcomeReason,
 PoolKit poolKit)
                                     throws DAValidateException,
DAException

Loads the outcome reason from the given id.

Parameters:

outcomeReason - the outcome reason id

poolKit - the PoolKit

Returns:

the loaded outcome reason

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadReasonType

protected BOOutcomeReasonType loadReasonType(Long outcomeReasonType,
 PoolKit poolKit)
                                      throws DAValidateException,
DAException

Loads the reason type from the given id.

Parameters:

outcomeReasonType - the outcome reason type id

poolKit - the PoolKit

Returns:

the loaded outcome reason type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

isLastAppointment

protected boolean isLastAppointment(List<InterventionAggregate> sameAppointmentIntervention)

Checks if the intervention appointment is last one for the given work order operation.

Parameters:

sameAppointmentIntervention - list of InterventionAggregate

Returns:

true if the appointment is the last one for the given intervention

getInterventionGroup

protected Long getInterventionGroup(PoolKit poolKit)
                             throws DAValidateException,
DAException

Returns the intervention group.

Parameters:

poolKit - the PoolKit

Returns:

the intervention group

Throws:

DAValidateException - the DA validate exception

DAException

getIntegrationService

protected WorkOrdersIntegrationService getIntegrationService(PoolKit poolKit)
                                                      throws DAValidateException

Returns the integration service.

Parameters:

poolKit - the PoolKit

Returns:

the integration service

Throws:

DAValidateException - the DA validate exception