Package overit.geocallapp.wfm.core.bl.crewshell.configuration.operationcenter.task

Class BTCrewShellOperationCenterDelete

java.lang.Object

overit.geocall.bl.BusinessTask<CrewShellOperationCenterDeleteEvent>

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

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

overit.geocallapp.wfm.core.bl.crewshell.configuration.operationcenter.task.BTCrewShellOperationCenterDelete

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(CrewShellOperationCenterDeleteEvent.class)
public class BTCrewShellOperationCenterDelete
extends ValidPermissionBusinessTask<CrewShellOperationCenterDeleteEvent>

Business task to delete a BOCrewShellOperationCenter object.
When the CrewShellOperationCenterDeleteEvent event is launched the BT notices the call and deletes the BOCrewShellOperationCenter object basing on the event's input.
The deletion of a BOCrewShellOperationCenter object indicates the deactivation of the BOCrewShell objects that were previously activated for the associated BOOperationCenter object. The deactivation of the BOCrewShell objects for the associated BOOperationCenter object implies that the crew shells' compositions, skills, addresses, calendars and schedulings are no longer updatable.

Since:

16.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected BOCache<BOCrewShellOperationCenter>	crewShellOperationCenterBOCache
protected BOCache<BOOperationCenter>	operationCenterBOCache
protected BOCache<WorkOrder>	workOrderBOCache
protected BOCache<BOWorkOrderOperation>	workOrderOperationBOCache

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTCrewShellOperationCenterDelete()

Method Summary

Modifier and Type	Method	Description
protected void	deactivateCrewShells(BOCrewShellOperationCenter input, PoolKit poolKit)	Deactivates all the BOCrewShell objects (i.e., crew shells) associated to the BOCrewShellOperationCenter input to be deleted by launching a CrewShellUpdateEvent event.
protected void	execute(CrewShellOperationCenterDeleteEvent event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected void	initCache()	Initializes the BOCache object for each business object.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected List<BOCrewShell>	retrieveCrewShellsByOC(BOCrewShellOperationCenter input, PoolKit poolKit)	Retrieves the BOCrewShell objects (i.e., crew shells) associated with the given BOOperationCenter object (i.e., operation center).
protected List<BOOperationCenter>	retrieveOperationCenters(PoolKit poolKit)	Retrieves the list of all the BOOperationCenter objects (i.e., operation centers).
protected List<Long>	retrieveOperationCentersIDs(PoolKit poolKit)	Retrieves the list of all the BOOperationCenter objects' IDs (i.e., the IDs of the operation centers).
protected List<BOScheduling>	retrieveSchedulings(BOWorkShift workShift, PoolKit poolKit)	Retrieves the BOScheduling objects (i.e., schedulings) related to each BOCrewShell object (i.e., crew shell).
protected BOWorkOrderHeader	retrieveWorkOrder(Long workOrderOperationID, PoolKit poolKit)	Retrieves the BOWorkOrderHeader object related to each BOCrewShell object (i.e., crew shell).
protected void	validateCrewShellsDeactivationForOperationCenter(BOCrewShellOperationCenter input, PoolKit poolKit)	Validates the deletion of a BOCrewShellOperationCenter object.
protected void	validateExistingDeactivation(BOCrewShellOperationCenter input, PoolKit poolKit)	Validates whether the BOCrewShell objects (i.e., crew shells) have not already been deactivated for the associated BOOperationCenter object (i.e., operation center).
protected void	validateOperationCenter(BOCrewShellOperationCenter input, PoolKit poolKit)	Validates whether the associated BOOperationCenter object is not null.
protected void	validateScheduledActivitiesToBePerformed(BOCrewShellOperationCenter input, PoolKit poolKit)	Validates whether the BOCrewShell objects (i.e., crew shells) to be deactivated for the associated BOOperationCenter object (i.e., operation center), both present and future, do not have any BOWorkOrderHeader object that is not TECHNICALLY_CLOSED, CLOSED or CANCELLED (i.e., open or pending work orders).

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

operationCenterBOCache

protected BOCache<BOOperationCenter> operationCenterBOCache

workOrderBOCache

protected BOCache<WorkOrder> workOrderBOCache

workOrderOperationBOCache

protected BOCache<BOWorkOrderOperation> workOrderOperationBOCache

crewShellOperationCenterBOCache

protected BOCache<BOCrewShellOperationCenter> crewShellOperationCenterBOCache

Constructor Details

BTCrewShellOperationCenterDelete

public BTCrewShellOperationCenterDelete()

Method Details

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

execute

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

Description copied from class: ValidExecutionBusinessTask

Executes the actual business logic after validation has passed.

Specified by:

execute in class ValidExecutionBusinessTask<CrewShellOperationCenterDeleteEvent>

Parameters:

event - the input event to process

poolKit - the PoolKit

Throws:

DAValidateException - if validation fails during execution

DAException - if a data access error occurs during execution

validateCrewShellsDeactivationForOperationCenter

protected void validateCrewShellsDeactivationForOperationCenter(BOCrewShellOperationCenter input,
 PoolKit poolKit)
                                                         throws DAValidateException,
DAException

Validates the deletion of a BOCrewShellOperationCenter object. Remember that the deletion of a BOCrewShellOperationCenter object implies the deactivation of the BOCrewShell objects for the related BOOperationCenter object. The deactivation is possible if and only if: the given BOOperationCenter object is not null; the BOCrewShell objects have not been already deactivated for the given BOOperationCenter object; the BOCrewShell objects, both present and future, do not have any BOWorkOrderHeader object which status is not TECHNICALLY_CLOSED, CLOSED or CANCELLED.

Parameters:

input - the BOCrewShellOperationCenter object to be validated

poolKit - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

validateOperationCenter

protected void validateOperationCenter(BOCrewShellOperationCenter input,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Validates whether the associated BOOperationCenter object is not null. If the associated BOOperationCenter object is null, it throws a DAValidateException object (i.e., CREW_SHELLS_CANNOT_BE_DEACTIVATED_FOR_UNEXISTING_OC).

Parameters:

input - the BOCrewShellOperationCenter exists

poolKit - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

validateExistingDeactivation

protected void validateExistingDeactivation(BOCrewShellOperationCenter input,
 PoolKit poolKit)
                                     throws DAValidateException,
DAException

Validates whether the BOCrewShell objects (i.e., crew shells) have not already been deactivated for the associated BOOperationCenter object (i.e., operation center). If the crew shells have already been deactivated for the associated operation center, it throws a DAValidateException object (i.e., CREW_SHELLS_ALREADY_DEACTIVATED_FOR_OC).

Parameters:

input - the BOCrewShellOperationCenter object to be deleted

poolKit - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

validateScheduledActivitiesToBePerformed

protected void validateScheduledActivitiesToBePerformed(BOCrewShellOperationCenter input,
 PoolKit poolKit)
                                                 throws DAException,
DAValidateException

Validates whether the BOCrewShell objects (i.e., crew shells) to be deactivated for the associated BOOperationCenter object (i.e., operation center), both present and future, do not have any BOWorkOrderHeader object that is not TECHNICALLY_CLOSED, CLOSED or CANCELLED (i.e., open or pending work orders). If the crew shells to be deactivated for the associated operation center have open or pending work orders, it throws a DAValidateException object (i.e., CREW_SHELL_CANNOT_BE_DEACTIVATED_FOR_PENDING_WORK_ORDERS).

Parameters:

input - the BOCrewShellOperationCenter object to be deleted

poolKit - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

retrieveOperationCenters

protected List<BOOperationCenter> retrieveOperationCenters(PoolKit poolKit)
                                                    throws DAValidateException,
DAException

Retrieves the list of all the BOOperationCenter objects (i.e., operation centers).

Parameters:

poolKit - the PoolKit

Returns:

the list of all the operation centers

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

retrieveOperationCentersIDs

protected List<Long> retrieveOperationCentersIDs(PoolKit poolKit)
                                          throws DAException,
DAValidateException

Retrieves the list of all the BOOperationCenter objects' IDs (i.e., the IDs of the operation centers).

Parameters:

poolKit - the PoolKit

Returns:

the list of the operation centers' IDs

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

retrieveCrewShellsByOC

protected List<BOCrewShell> retrieveCrewShellsByOC(BOCrewShellOperationCenter input,
 PoolKit poolKit)
                                            throws DAValidateException,
DAException

Retrieves the BOCrewShell objects (i.e., crew shells) associated with the given BOOperationCenter object (i.e., operation center).

Parameters:

input - the BOCrewShellOperationCenter object

poolKit - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

retrieveSchedulings

protected List<BOScheduling> retrieveSchedulings(BOWorkShift workShift,
 PoolKit poolKit)
                                          throws DAException,
DAValidateException

Retrieves the BOScheduling objects (i.e., schedulings) related to each BOCrewShell object (i.e., crew shell).

Parameters:

workShift - the BOWorkShift object

poolKit - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

retrieveWorkOrder

protected BOWorkOrderHeader retrieveWorkOrder(Long workOrderOperationID,
 PoolKit poolKit)
                                       throws DAValidateException,
DAException

Retrieves the BOWorkOrderHeader object related to each BOCrewShell object (i.e., crew shell).

Parameters:

workOrderOperationID - the ID of the BOWorkOrderOperation object

poolKit - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

deactivateCrewShells

protected void deactivateCrewShells(BOCrewShellOperationCenter input,
 PoolKit poolKit)
                             throws DAException,
DAValidateException

Deactivates all the BOCrewShell objects (i.e., crew shells) associated to the BOCrewShellOperationCenter input to be deleted by launching a CrewShellUpdateEvent event.

Parameters:

input - the BOCrewShellOperationCenter object to be inserted

poolKit - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

initCache

protected void initCache()

Initializes the BOCache object for each business object.