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

Class BTInterventionResourceDelete

java.lang.Object

overit.geocall.bl.BusinessTask<InterventionResourceDeleteEvent>

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

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

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

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(InterventionResourceDeleteEvent.class)
public class BTInterventionResourceDelete
extends ValidPermissionBusinessTask<InterventionResourceDeleteEvent>

Business task to remove a intervention resource.

Permission:

• ExecutionPermissions.FSM_CORE_WORKORDER_ACCOUNTING_EDIT

Error Code:

• Codes.MISSING_REQUIRED_PERMISSION
• Codes.GC_NOT_FOUND
• Codes.InterventionResource.VALIDATED_INTERVENTION_RESOURCE

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
BTInterventionResourceDelete()

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	deleteInterventionResource(BOInterventionResource interventionResource, PoolKit poolKit)	Deletes an BOInterventionResource.
protected void	execute(InterventionResourceDeleteEvent event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected WorkOrdersIntegrationService	getIntegrationService(PoolKit poolKit)	Retrieves the WorkOrdersIntegrationService instance.
protected BOInterventionResource	getInterventionResource(InterventionResourceDeleteInput interventionResourceDeleteInput, PoolKit poolKit)	Retrieves a list of BOInterventionResource objects based on the provided BOInterventionResource.
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, PoolKit poolKit)	Manages the work order operation resource associated with the provided BOInterventionResource.
protected void	notifyInterventionResource(BOInterventionResource interventionResource, PoolKit poolKit)	Sends an intervention resource notification.
protected void	notifyWorkOrderOperationResource(BOWorkOrderOperationResource workOrderOperationResource, PoolKit poolKit)	Sends a work order operation resource notification.
protected void	removeWorkOrderOperationResource(BOWorkOrderOperationResource workOrderOperationResource, PoolKit poolKit)	Remove an existing BOWorkOrderOperationResource.
protected List<BOWorkOrderOperationResource>	searchWorkOrderOperationResources(BOInterventionResource interventionResource, PoolKit poolKit)	Searches for BOWorkOrderOperationResource entities based on the provided 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, PoolKit poolKit)	Check on mandatory fields and visibility of properties.

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

BTInterventionResourceDelete

public BTInterventionResourceDelete()

Method Details

execute

protected void execute(InterventionResourceDeleteEvent 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<InterventionResourceDeleteEvent>

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

getInterventionResource

protected BOInterventionResource getInterventionResource(InterventionResourceDeleteInput interventionResourceDeleteInput,
 PoolKit poolKit)
                                                  throws DAValidateException,
DAException

Retrieves a list of BOInterventionResource objects based on the provided BOInterventionResource.

Parameters:

interventionResourceDeleteInput - the InterventionResourceDeleteInput to use as a filter

poolKit - the PoolKit to use for the search

Returns:

a BOInterventionResource that must be removed

Throws:

DAValidateException - if any required properties are missing in the BOInterventionResource

DAException - if an error occurs during the search

validate

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

Check on mandatory fields and visibility of properties.

Parameters:

interventionResource - the BOInterventionResource

poolKit - the PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

manageWorkOrderOperationResource

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

Manages the work order operation resource associated with the provided BOInterventionResource.

Parameters:

interventionResource - the BOInterventionResource to use for managing the work order operation resource

poolKit - the PoolKit to use for the operation

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

searchWorkOrderOperationResources

protected List<BOWorkOrderOperationResource> searchWorkOrderOperationResources(BOInterventionResource interventionResource,
 PoolKit poolKit)
                                                                        throws DAValidateException,
DAException

Searches for BOWorkOrderOperationResource entities based on the provided BOInterventionResource.

Parameters:

interventionResource - the BOInterventionResource to use for the search

poolKit - the PoolKit to use for the search

Returns:

a list of BOWorkOrderOperationResource entities matching the search criteria

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

poolKit - the PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

removeWorkOrderOperationResource

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

Remove an existing BOWorkOrderOperationResource.

Parameters:

workOrderOperationResource - the BOWorkOrderOperationResource

poolKit - the PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

deleteInterventionResource

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

Deletes an BOInterventionResource.

Parameters:

interventionResource - the BOInterventionResource to delete

poolKit - the PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

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 there is a validation error.

DAException - If an error occurs during the data access.

notifyInterventionResource

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

Sends an intervention resource notification.

Parameters:

interventionResource - The BOInterventionResource object representing the agenda resource.

poolKit - The PoolKit

Throws:

DAValidateException - If there is a validation error.

DAException - If an error occurs during the data access.

notifyWorkOrderOperationResource

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

Sends a work order operation resource notification.

Parameters:

workOrderOperationResource - The BOWorkOrderOperationResource object representing the work order operation 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

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

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

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 there is a validation error.

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