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

Class BTInterventionResourceUpdate

java.lang.Object

overit.geocall.bl.BusinessTask<InterventionResourceUpdateEvent>

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

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

overit.geocallapp.wfm.orchestrator.workorders.bl.intervention.resource.task.BTInterventionResourceUpdate

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(InterventionResourceUpdateEvent.class)
public class BTInterventionResourceUpdate
extends ValidPermissionBusinessTask<InterventionResourceUpdateEvent>

Business task to update a intervention resource.

Permission:

• ExecutionPermissions.FSM_CORE_WORKORDER_ACCOUNTING_EDIT

Error Code:

• Codes.MISSING_REQUIRED_PERMISSION
• Codes.PROPERTY_REQUIRED
• Codes.INVALID_DATE_INTERVAL_BEFORE
• Codes.INVALID_DATE_INTERVAL_AFTER
• Codes.InterventionResource.SPENT_TIME_REQUIRED
• Codes.InterventionResource.WORK_ORDER_CLOSED

Since:

18.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected BOIntervention	intervention
protected BOWorkOrderOperation	workOrderOperation

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTInterventionResourceUpdate()

Method Summary

Modifier and Type	Method	Description
protected void	checkWorkOrderStatus(BOInterventionResource interventionResource, PoolKit poolKit)	Checks the status of the work order associated with the provided BOInterventionResource.
protected void	execute(InterventionResourceUpdateEvent event, PoolKit poolKit)	Executes the intervention resource update process.
protected BOInterventionResource	getExistingInterventionResource(BOInterventionResource interventionResource, PoolKit poolKit)	Retrieves the existing BOInterventionResource to be updated.
protected WorkOrdersIntegrationService	getIntegrationService(PoolKit poolKit)	Retrieves the WorkOrdersIntegrationService instance.
protected Long	getNearestWorkShift(BOInterventionResource interventionResource, PoolKit poolKit)	Retrieves the nearest work shift for the given intervention resource.
protected BOWorkOrderOperation	getWorkOrderOperation(BOInterventionResource interventionResource, PoolKit poolKit)	Retrieves the BOWorkOrderOperation associated with the provided BOInterventionResource.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected void	manageWorkOrderOperationResource(BOInterventionResource interventionResource, BOInterventionResource existingInterventionResource, PoolKit poolKit)	Updates a BOWorkOrderOperationResource based on the provided BOInterventionResource.
protected void	notifyInterventionResource(BOInterventionResource interventionResource, PoolKit poolKit)	Sends an intervention resource notification.
protected void	updateInterventionResource(BOInterventionResource interventionResource, PoolKit poolKit)	Updates a BOInterventionResource.
protected void	updateValidationStatus(PoolKit poolKit)	Updates the validation status by calling the InterventionOutcomeValidationStatusUpdateEvent
protected void	updateWorkOrder(PoolKit poolKit)	Updates the work order header after an intervention resource has been inserted.
protected void	updateWorkOrderOperationResource(BOWorkOrderOperationResource workOrderOperationResource, PoolKit poolKit)	Updates an existing BOWorkOrderOperationResource.
protected void	validate(BOInterventionResource interventionResource, BOInterventionResource existingInterventionResource, PoolKit poolKit)	Check on mandatory fields and visibility of properties.
protected void	validateDates(BOInterventionResource interventionResource)	Validates the date-related properties of the provided BOInterventionResource.

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

intervention

protected BOIntervention intervention

workOrderOperation

protected BOWorkOrderOperation workOrderOperation

Constructor Details

BTInterventionResourceUpdate

public BTInterventionResourceUpdate()

Method Details

execute

protected void execute(InterventionResourceUpdateEvent event,
 PoolKit poolKit)
                throws DAException,
DAValidateException

Executes the intervention resource update process.

This method performs the following steps:

• Validates the provided BOInterventionResource instance
• Updates the intervention resource
• Updates the work order operation resource
• Updates the work order
• Notifies about the intervention resource update
• Updates the intervention outcome validation status

Specified by:

execute in class ValidExecutionBusinessTask<InterventionResourceUpdateEvent>

Parameters:

event - the InterventionResourceUpdateEvent containing the input BOInterventionResource

poolKit - the PoolKit

Throws:

DAException - if any data access exception occurs

DAValidateException - if any data validation exception occurs

validate

protected void validate(BOInterventionResource interventionResource,
 BOInterventionResource existingInterventionResource,
 PoolKit poolKit)
                 throws DAValidateException,
DAException

Check on mandatory fields and visibility of properties.

Parameters:

interventionResource - the BOInterventionResource

existingInterventionResource - the existing BOInterventionResource to be updated

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

validateDates

protected void validateDates(BOInterventionResource interventionResource)
                      throws DAValidateException

Validates the date-related properties of the provided BOInterventionResource.

Parameters:

interventionResource - the BOInterventionResource to validate

Throws:

DAValidateException - if any of the date-related properties are missing or invalid

getExistingInterventionResource

protected BOInterventionResource getExistingInterventionResource(BOInterventionResource interventionResource,
 PoolKit poolKit)
                                                          throws DAValidateException,
DAException

Retrieves the existing BOInterventionResource to be updated.

Parameters:

interventionResource - the BOInterventionResource to use as a filter

poolKit - the PoolKit to use for the search

Returns:

a list of BOInterventionResource objects matching the filter

Throws:

DAValidateException - if any required properties are missing in the BOInterventionResource

DAException - if an error occurs during the search

checkWorkOrderStatus

protected void checkWorkOrderStatus(BOInterventionResource interventionResource,
 PoolKit poolKit)
                             throws DAValidateException,
DAException

Checks the status of the work order associated with the provided BOInterventionResource.

Parameters:

interventionResource - the BOInterventionResource to check the work order status for

poolKit - the PoolKit

Throws:

DAValidateException - if the work order is in a closed, aligned, or cancelled state

DAException - if an error occurs during the check

getWorkOrderOperation

protected BOWorkOrderOperation getWorkOrderOperation(BOInterventionResource interventionResource,
 PoolKit poolKit)
                                              throws DAValidateException,
DAException

Retrieves the BOWorkOrderOperation associated with the provided BOInterventionResource.

Parameters:

interventionResource - the BOInterventionResource to use for retrieving the BOWorkOrderOperation

poolKit - the PoolKit to use for the retrieval

Returns:

the BOWorkOrderOperation associated with the provided BOInterventionResource

Throws:

DAValidateException - if any validation error occurs during the retrieval

DAException - if an error occurs during the retrieval

updateInterventionResource

protected void updateInterventionResource(BOInterventionResource interventionResource,
 PoolKit poolKit)
                                   throws DAException,
DAValidateException

Updates a BOInterventionResource.

Parameters:

interventionResource - the BOInterventionResource to update

poolKit - the PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

getNearestWorkShift

protected Long getNearestWorkShift(BOInterventionResource interventionResource,
 PoolKit poolKit)
                            throws DAException,
DAValidateException

Retrieves the nearest work shift for the given intervention resource.

Parameters:

interventionResource - the BOInterventionResource to find the nearest work shift for

poolKit - the PoolKit

Returns:

the id of the nearest work shift, or null if no work shift is found

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

manageWorkOrderOperationResource

protected void manageWorkOrderOperationResource(BOInterventionResource interventionResource,
 BOInterventionResource existingInterventionResource,
 PoolKit poolKit)
                                         throws DAValidateException,
DAException

Updates a BOWorkOrderOperationResource based on the provided BOInterventionResource. If a matching BOWorkOrderOperationResource is found, the spent time is updated. Otherwise, a new BOWorkOrderOperationResource is created.

Parameters:

interventionResource - the BOInterventionResource

existingInterventionResource -

poolKit - the PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

updateWorkOrderOperationResource

protected void updateWorkOrderOperationResource(BOWorkOrderOperationResource workOrderOperationResource,
 PoolKit poolKit)
                                         throws DAValidateException,
DAException

Updates an existing BOWorkOrderOperationResource.

Parameters:

workOrderOperationResource - the BOWorkOrderOperationResource to update

poolKit - the PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

updateWorkOrder

protected void updateWorkOrder(PoolKit poolKit)
                        throws DAValidateException,
DAException

Updates the work order header after an intervention resource has been inserted.

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - if there is a validation error

DAException - if there is a data access exception

notifyInterventionResource

protected void notifyInterventionResource(BOInterventionResource interventionResource,
 PoolKit poolKit)
                                   throws DAValidateException,
DAException

Sends an intervention resource notification.

Parameters:

interventionResource - The BOInterventionResource object representing the intervention resource.

poolKit - The PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

updateValidationStatus

protected void updateValidationStatus(PoolKit poolKit)
                               throws DAValidateException,
DAException

Updates the validation status by calling the InterventionOutcomeValidationStatusUpdateEvent

Parameters:

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

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.

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