Package overit.geocallapp.wfm.orchestrator.scheduling.bl.activityvalidation.task

Class BTWorkShiftActivityValidation

java.lang.Object

overit.geocall.bl.BusinessTask<WorkShiftActivityValidationEvent>

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

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

overit.geocallapp.wfm.orchestrator.scheduling.bl.activityvalidation.task.BTWorkShiftActivityValidation

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(WorkShiftActivityValidationEvent.class)
public class BTWorkShiftActivityValidation
extends ValidPermissionBusinessTask<WorkShiftActivityValidationEvent>

Business task that validate all the work shifts as input.
It updates the agenda status and operation status and call the SchedulingNotificationEvent for the valid operations related to the work shifts.
Error Code:

• Codes.ManualScheduling.CREWSHELL_NOT_VALID
• Codes.ManualScheduling.WORKSHIFT_NOT_VALID
• Codes.ManualScheduling.NO_VALID_OPERATIONS_WORKSHIFT

Since:

17.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTWorkShiftActivityValidation()

Method Summary

Modifier and Type	Method	Description
protected void	associateOperationWithWorkShift(List<BOWorkShift> workShifts, PoolKit poolKit)	Creates the map containing the link between operation and work shifts (key: operation id and value: all the related work shifts for that operation id).
protected void	checkCrewShellWorkShifts(List<BOWorkShift> workShifts, PoolKit poolKit)	Validate the work shifts in input, the steps are the following: 1.
protected void	execute(WorkShiftActivityValidationEvent event, PoolKit poolKit)	Executes the actual business logic after validation has passed.
protected SchedulingIntegrationService	getIntegrationService(PoolKit poolKit)
protected BOWorkShift	getRelatedWorkShift(BOWorkOrderOperation validOperation, List<BOWorkShift> mapWorkShifts)	Get work shifts for the operation, we might have more than one work shift associated to the same operation in the "team case".
protected List<BOAgenda>	getValidAgendas(BOWorkOrderOperation validOperation, PoolKit poolKit)	Method that returns the valid agendas related to the operation in input.
protected List<BOWorkOrderOperation>	getValidOperations(PoolKit poolKit)	Method that returns a list of valid work order operations(where status is not CANCELLED or CLOSED).
protected List<Date>	getWorkShiftDays(PoolKit poolKit, Long workShiftId)	Retrieves the list of work shift days for a specific work shift.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected void	launchCompleteManualActionEvent(PoolKit poolKit)	Method that calls the SchedulingNotificationEvent at the end of the validation.
protected void	notifyActivityValidated(BOWorkOrderOperation validOperation, List<BOWorkShift> workShifts, PoolKit poolKit)	Notifies the validation of an activity.
protected void	recalculateWorkOrderOperationStatus(Long operationId, PoolKit poolKit)	Recalculates the work order operation status.
protected void	updateAgendaStatus(List<BOAgenda> validAgendas, PoolKit poolKit)	Update the status of the agenda if its status is equal to OPEN.
protected void	updateStatus(BOWorkOrderOperation validOperation, List<BOAgenda> validAgendas, PoolKit poolKit)	Method that updates the operation and agenda status.
protected void	validate(PoolKit poolKit)	Validates the data before performing the work shift activity validation.

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

Constructor Details

BTWorkShiftActivityValidation

public BTWorkShiftActivityValidation()

Method Details

execute

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

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

checkCrewShellWorkShifts

protected void checkCrewShellWorkShifts(List<BOWorkShift> workShifts,
 PoolKit poolKit)
                                 throws DAValidateException,
DAException

Validate the work shifts in input, the steps are the following: 1. Check if work shift is crew shell, if not it doesn't do any checks 2. If work shift is crew shell it search the crew shell by setting the dummy user equal to the work shift user If a crew shell is found is means the work shift is the correct crew shell's work shift, if no crews shells are found it means that in input we have a work shift of a technicians working in a crew shell. After this check is performed a check in the composition that can't be empty

Parameters:

workShifts - the list of work shifts to be checked

poolKit - the PoolKit

Throws:

DAValidateException - if the work shift is not valid

DAException - if an error occurs during the process

getWorkShiftDays

protected List<Date> getWorkShiftDays(PoolKit poolKit,
 Long workShiftId)
                               throws DAValidateException,
DAException

Retrieves the list of work shift days for a specific work shift.

Parameters:

poolKit - the PoolKit

workShiftId - the ID of the work shift

Returns:

the list of work shift days

Throws:

DAValidateException - if the work shift is not valid

DAException - if an error occurs during the process

getIntegrationService

protected SchedulingIntegrationService getIntegrationService(PoolKit poolKit)
                                                      throws DAValidateException

Throws:

DAValidateException

associateOperationWithWorkShift

protected void associateOperationWithWorkShift(List<BOWorkShift> workShifts,
 PoolKit poolKit)
                                        throws DAException,
DAValidateException

Creates the map containing the link between operation and work shifts (key: operation id and value: all the related work shifts for that operation id).

Parameters:

workShifts - the input work shifts

Throws:

DAException

DAValidateException

validate

protected void validate(PoolKit poolKit)
                 throws DAValidateException,
DAException

Validates the data before performing the work shift activity validation.

Throws:

DAValidateException - the DA validate exception

DAException

getValidOperations

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

Method that returns a list of valid work order operations(where status is not CANCELLED or CLOSED).

Parameters:

poolKit - the PoolKit

Returns:

a list of the work order operations that are not in status CANCELLED or CLOSED

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getRelatedWorkShift

protected BOWorkShift getRelatedWorkShift(BOWorkOrderOperation validOperation,
 List<BOWorkShift> mapWorkShifts)

Get work shifts for the operation, we might have more than one work shift associated to the same operation in the "team case". But we just need operationCenter and start date and these data don't change between work shifts of the same operation.

Parameters:

validOperation - the operation to be validated

mapWorkShifts - a map containing id of work shift as key and as value its related BOWorkShift so we don't have to load again the work shifts.

Returns:

BOWorkShift related to the operation

getValidAgendas

protected List<BOAgenda> getValidAgendas(BOWorkOrderOperation validOperation,
 PoolKit poolKit)
                                  throws DAException,
DAValidateException

Method that returns the valid agendas related to the operation in input.

Parameters:

validOperation - an operation in status != CANCELLED or CLOSED

poolKit - the PoolKit

Returns:

a list of valid agendas

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

updateStatus

protected void updateStatus(BOWorkOrderOperation validOperation,
 List<BOAgenda> validAgendas,
 PoolKit poolKit)
                     throws DAException,
DAValidateException

Method that updates the operation and agenda status.

Parameters:

validOperation - the operation to update the status

validAgendas - the agendas related to the operation to update the status

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

updateAgendaStatus

protected void updateAgendaStatus(List<BOAgenda> validAgendas,
 PoolKit poolKit)
                           throws DAException,
DAValidateException

Update the status of the agenda if its status is equal to OPEN.

Parameters:

validAgendas - list of BOAgenda

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

recalculateWorkOrderOperationStatus

protected void recalculateWorkOrderOperationStatus(Long operationId,
 PoolKit poolKit)
                                            throws DAValidateException,
DAException

Recalculates the work order operation status.

Parameters:

operationId - the work order operation id

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

notifyActivityValidated

protected void notifyActivityValidated(BOWorkOrderOperation validOperation,
 List<BOWorkShift> workShifts,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Notifies the validation of an activity.

Parameters:

validOperation - The validated work order operation

workShifts - The list of work shifts

poolKit - The PoolKit

Throws:

DAValidateException - If the work shift is not valid

DAException - If an error occurs during the process

launchCompleteManualActionEvent

protected void launchCompleteManualActionEvent(PoolKit poolKit)
                                        throws DAException,
DAValidateException

Method that calls the SchedulingNotificationEvent at the end of the validation.

Parameters:

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

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