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

Class BTInterventionExecution<T extends InterventionExecutionInput>

java.lang.Object

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

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

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

overit.geocallapp.wfm.orchestrator.workorders.bl.outcome.intervention.task.BTInterventionExecution<T>

All Implemented Interfaces:

Serializable, Tool, ValidExecution

Direct Known Subclasses:

BTInterventionArrivalOnSite, BTInterventionStart, BTInterventionTakeInCharge

public abstract class BTInterventionExecution<T extends InterventionExecutionInput>
extends ValidPermissionBusinessTask<SimpleBusinessEvent<T,Void>>

An abstract class that extends ValidPermissionBusinessTask and represents a business task for executing an intervention. This class is responsible for:

• Validating the input: generic checks performed by the superclass, personal checks performed by the subclasses
• Finding interventions to be removed and removing other interventions from the foreman
• Performing the action (take in charge, arrival on site, intervention start), which is implemented in subclasses
• Recalculating the work order operation and status

Since:

18.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected BOIntervention	intervention
protected BOWorkOrderOperation	operation

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTInterventionExecution()

Method Summary

Modifier and Type	Method	Description
protected abstract void	checkDate(Date inputDate)	Checks the date in the given InterventionExecutionInput input object.
protected abstract void	checkInterventionStatus()	Checks the status of the intervention to ensure it is valid for the current operation.
protected void	execute(SimpleBusinessEvent<T,Void> event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected List<BOIntervention>	findInterventionsToBeRemoved(PoolKit poolKit)	This method finds the interventions that are associated with the same foreman id and with a different work order operation.
protected WorkOrdersIntegrationService	getIntegrationService(PoolKit poolKit)	Retrieves the WorkOrdersIntegrationService instance.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected void	notifyInterventionOutcome(BOInterventionOutcome interventionOutcome, PoolKit poolKit, InterventionOutcomeNotificationAction action)	Notifies that the intervention outcome was modified by calling InterventionOutcomeNotificationEvent
protected abstract void	performInterventionAction(InterventionExecutionInput input, PoolKit poolKit)
protected void	recalculateWorkOrderOperationStatus(PoolKit poolKit)	Recalculates the work order operation status.
protected void	recalculateWorkOrderStatus(PoolKit poolKit)	Recalculate work order status.
protected void	removeOtherInterventionsFromForeman(List<BOIntervention> interventionsToBeRemoved, PoolKit poolKit)	Removes other interventions from foreman by calling InterventionExecutionDeleteEvent
protected void	updateWorkOrderOperation(PoolKit poolKit)	Updates the work order operation by launching WorkOrderOperationUpdateEvent.
protected void	validateInput(InterventionExecutionInput input, PoolKit poolKit)	Validates the input for the intervention execution task.

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

operation

protected BOWorkOrderOperation operation

intervention

protected BOIntervention intervention

Constructor Details

BTInterventionExecution

public BTInterventionExecution()

Method Details

execute

protected void execute(SimpleBusinessEvent<T,Void> 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 InterventionExecutionInput,Void>>

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

validateInput

protected void validateInput(InterventionExecutionInput input,
 PoolKit poolKit)
                      throws DAValidateException,
DAException

Validates the input for the intervention execution task.

Parameters:

input - The InterventionExecutionInput input object.

poolKit - the PoolKit

Throws:

DAValidateException - If any validation error occurs.

DAException - If any error occurs during the validation process.

checkDate

protected abstract void checkDate(Date inputDate)
                           throws DAValidateException

Checks the date in the given InterventionExecutionInput input object.

Parameters:

inputDate - The date of the InterventionExecutionInput input object to check.

Throws:

DAValidateException - If any validation error occurs during the date check.

checkInterventionStatus

protected abstract void checkInterventionStatus()
                                         throws DAValidateException

Checks the status of the intervention to ensure it is valid for the current operation.

Throws:

DAValidateException - If the intervention status is not valid.

getIntegrationService

protected WorkOrdersIntegrationService getIntegrationService(PoolKit poolKit)
                                                      throws DAValidateException

Retrieves the WorkOrdersIntegrationService instance. If the instance hasn't been created yet, it will be created and stored for future use.

Parameters:

poolKit - The PoolKit.

Returns:

The WorkOrdersIntegrationService instance.

Throws:

DAValidateException - If any validation error occurs.

findInterventionsToBeRemoved

protected List<BOIntervention> findInterventionsToBeRemoved(PoolKit poolKit)
                                                     throws DAValidateException,
DAException

This method finds the interventions that are associated with the same foreman id and with a different work order operation.

Parameters:

poolKit - the PoolKit

Returns:

The list of BOIntervention objects to be removed.

Throws:

DAValidateException - If the intervention status is not valid.

DAException - If an error occurs during the process.

removeOtherInterventionsFromForeman

protected void removeOtherInterventionsFromForeman(List<BOIntervention> interventionsToBeRemoved,
 PoolKit poolKit)
                                            throws DAException,
DAValidateException

Removes other interventions from foreman by calling InterventionExecutionDeleteEvent

Parameters:

interventionsToBeRemoved - the list of BOIntervention objects to be removed

poolKit - the PoolKit

Throws:

DAException - If any error occurs during the deletion process

DAValidateException - If any validation error occurs

performInterventionAction

protected abstract void performInterventionAction(InterventionExecutionInput input,
 PoolKit poolKit)
                                           throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

updateWorkOrderOperation

protected void updateWorkOrderOperation(PoolKit poolKit)
                                 throws DAException,
DAValidateException

Updates the work order operation by launching WorkOrderOperationUpdateEvent.

Parameters:

poolKit - The PoolKit

Throws:

DAException - If any error occurs during the update process.

DAValidateException - If any validation error occurs.

notifyInterventionOutcome

protected void notifyInterventionOutcome(BOInterventionOutcome interventionOutcome,
 PoolKit poolKit,
 InterventionOutcomeNotificationAction action)
                                  throws DAException,
DAValidateException

Notifies that the intervention outcome was modified by calling InterventionOutcomeNotificationEvent

Parameters:

interventionOutcome - the BOInterventionOutcome to notify

poolKit - the PoolKit

action - the InterventionOutcomeNotificationAction representing the action that was performed

Throws:

DAException - if an error occurs during the notification process

DAValidateException - if any validation error occurs

recalculateWorkOrderOperationStatus

protected void recalculateWorkOrderOperationStatus(PoolKit poolKit)
                                            throws DAValidateException,
DAException

Recalculates the work order operation status.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - If any validation error occurs.

DAException - If an error occurs during the process.

recalculateWorkOrderStatus

protected void recalculateWorkOrderStatus(PoolKit poolKit)
                                   throws DAValidateException,
DAException

Recalculate work order status.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - If any validation error occurs.

DAException - If any error occurs during the notification process.

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