Package overit.geocallapp.wfm.orchestrator.workorders.bl.bundler.bundle.task

Class BTBundleOperationAdd

java.lang.Object

overit.geocall.bl.BusinessTask<BundleOperationAddEvent>

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

overit.geocallapp.wfm.bundler.bl.task.BTBundler<BundleOperationAddEvent>

overit.geocallapp.wfm.orchestrator.workorders.bl.bundler.bundle.task.BTBundleOperationAdd

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(BundleOperationAddEvent.class)
public class BTBundleOperationAdd
extends BTBundler<BundleOperationAddEvent>

Business task in order to add a list of BOBundleOperation to a Bundle.
When the BundleOperationAddEvent is launched the BT notices the call and adds all the BOBundleOperations to the Bundle basing on the event's input.

Permission:

• BundlerPermissions.BUNDLE_EDIT

Error Code:

• Codes.OPERATION_NOT_PERMITTED
• Codes.Bundler.BUNDLE_NOT_SCHEDULABLE
• Codes.Bundler.BUNDLE_OPERATION_NOT_FOUND_IN_BUNDLE
• Codes.Bundler.BUNDLE_OPERATION_NOT_SCHEDULABLE

Visibility:

• bundle headers associated to the same current user's operation center

Since:

20.1

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTBundleOperationAdd()

Method Summary

Modifier and Type	Method	Description
protected void	calculateBundleAttributes(Bundle bundle, PoolKit poolKit)	Calculates the scheduling attributes for the current Bundle.
protected void	checkUserPermissions()	Checks if the user has the required permission.
protected List<BOBundleOperation>	createBundleOperations(Bundle bundle, List<Long> workOrderOperationIds, PoolKit poolKit)	Creates a new BOBundleOperation for every BOWorkOrderOperation of the given list.
protected void	deleteSkillDivisions(Bundle bundle, PoolKit poolKit)	Deletes all the existing relation between the skill divisions and the given Bundle.
protected void	deleteSkills(Bundle bundle, PoolKit poolKit)	Deletes all the existing relation between the skills and the given Bundle.
protected void	execute(BundleOperationAddEvent event, PoolKit poolKit)	Starting from the given BundleOperationAddEvent input, the corresponding BOBundleOperation is created and added to the Bundle.
protected WorkOrdersIntegrationService	getIntegrationService(PoolKit poolKit)	Retrieves the WorkOrdersIntegrationService instance.
protected BOBundleOperation	insertBundleOperation(Bundle bundle, Long workOrderOperationId, PoolKit poolKit)	Inserts a new BOBundleOperation for the given BOWorkOrderOperation.
protected Long	insertSkill(BOBundleSkill bundleSkill, PoolKit poolKit)	Inserts the relation between the current Bundle and a skill.
protected Long	insertSkillDivision(BOBundleSkillDivision bundleSkillDivision, PoolKit poolKit)	Inserts the relation between the current Bundle and a skill division.
protected void	linkWorkOrderOperations(Bundle bundle, PoolKit poolKit)	Creates the new links for the BOWorkOrderOperations of the given Bundle.
protected Bundle	loadBundle(Long bundleId, PoolKit poolKit)	Loads the Bundle related to the given id.
protected List<BOWorkOrderOperation>	loadValidWorkOrderOperations(List<Long> workOrderOperationIds, PoolKit poolKit)	Loads the BOWorkOrderOperations related to the given ids and checks if they are valid for bundling.
protected void	notifyBundleOperation(BOBundleOperation bundleOperation, PoolKit poolKit)	Notifies the addition of the given BOBundleOperation.
protected void	recalculateLinks(Bundle bundle, PoolKit poolKit)	Recalculates the links between the BOWorkOrderOperations by unlinking them and relinking them together with the newly added one.
protected Long	saveBundle(Bundle bundle, PoolKit poolKit)	Saves the Bundle and adds the relation with the skills and skill divisions.
protected List<BOWorkOrderOperation>	searchWorkOrderOperations(List<Long> workOrderOperationIds, PoolKit poolKit)	Loads the list of BOWorkOrderOperation related to the given list of ids.
protected void	unlinkWorkOrderOperations(Bundle bundle, PoolKit poolKit)	Unlinks of the parent BOWorkOrderOperation from all its children.
protected void	updateBundle(Bundle bundle, PoolKit poolKit)	Updates the Bundle, recalculates all its attributes, including the skills and skill divisions.
protected void	validate(BundleOperationAddInput input, Bundle bundle)	Validates the input before adding the bundle operation.

Methods inherited from class overit.geocallapp.wfm.bundler.bl.task.BTBundler

getException, isValidExecution, throwExceptionIfInvalid

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask

body, checkValidExecution, 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

BTBundleOperationAdd

public BTBundleOperationAdd()

Method Details

execute

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

Starting from the given BundleOperationAddEvent input, the corresponding BOBundleOperation is created and added to the Bundle.

Specified by:

execute in class ValidExecutionBusinessTask<BundleOperationAddEvent>

Parameters:

event - the BundleOperationAddEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

checkUserPermissions

protected void checkUserPermissions()
                             throws DAValidateException

Checks if the user has the required permission.

Throws:

DAValidateException - the DA validate exception

loadBundle

protected Bundle loadBundle(Long bundleId,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Loads the Bundle related to the given id.

Parameters:

bundleId - the Bundle id

poolKit - the PoolKit

Returns:

the loaded Bundle

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

createBundleOperations

protected List<BOBundleOperation> createBundleOperations(Bundle bundle,
 List<Long> workOrderOperationIds,
 PoolKit poolKit)
                                                  throws DAValidateException,
DAException

Creates a new BOBundleOperation for every BOWorkOrderOperation of the given list.

Parameters:

bundle - the Bundle

workOrderOperationIds - list of BOWorkOrderOperation ids

poolKit - the PoolKit

Returns:

the list of created BOBundleOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadValidWorkOrderOperations

protected List<BOWorkOrderOperation> loadValidWorkOrderOperations(List<Long> workOrderOperationIds,
 PoolKit poolKit)
                                                           throws DAValidateException,
DAException

Loads the BOWorkOrderOperations related to the given ids and checks if they are valid for bundling.

Parameters:

workOrderOperationIds - the BOWorkOrderOperation ids

poolKit - the PoolKit

Returns:

the loaded BOWorkOrderOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

searchWorkOrderOperations

protected List<BOWorkOrderOperation> searchWorkOrderOperations(List<Long> workOrderOperationIds,
 PoolKit poolKit)
                                                        throws DAValidateException,
DAException

Loads the list of BOWorkOrderOperation related to the given list of ids.

Parameters:

workOrderOperationIds - list of BOWorkOrderOperation ids

poolKit - the PoolKit

Returns:

the list of loaded BOWorkOrderOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

validate

protected void validate(BundleOperationAddInput input,
 Bundle bundle)
                 throws DAValidateException

Validates the input before adding the bundle operation.

Parameters:

input - the BundleOperationAddInput

bundle - the Bundle

Throws:

DAValidateException - the DA validate exception

insertBundleOperation

protected BOBundleOperation insertBundleOperation(Bundle bundle,
 Long workOrderOperationId,
 PoolKit poolKit)
                                           throws DAValidateException,
DAException

Inserts a new BOBundleOperation for the given BOWorkOrderOperation.

Parameters:

bundle - the Bundle

workOrderOperationId - the BOWorkOrderOperation id

poolKit - the PoolKit

Returns:

the created BOBundleOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

updateBundle

protected void updateBundle(Bundle bundle,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Updates the Bundle, recalculates all its attributes, including the skills and skill divisions.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

recalculateLinks

protected void recalculateLinks(Bundle bundle,
 PoolKit poolKit)
                         throws DAValidateException,
DAException

Recalculates the links between the BOWorkOrderOperations by unlinking them and relinking them together with the newly added one.

Parameters:

bundle - the current Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

unlinkWorkOrderOperations

protected void unlinkWorkOrderOperations(Bundle bundle,
 PoolKit poolKit)
                                  throws DAValidateException,
DAException

Unlinks of the parent BOWorkOrderOperation from all its children.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

linkWorkOrderOperations

protected void linkWorkOrderOperations(Bundle bundle,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Creates the new links for the BOWorkOrderOperations of the given Bundle.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

calculateBundleAttributes

protected void calculateBundleAttributes(Bundle bundle,
 PoolKit poolKit)
                                  throws DAValidateException,
DAException

Calculates the scheduling attributes for the current Bundle.

Parameters:

bundle - the current Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

saveBundle

protected Long saveBundle(Bundle bundle,
 PoolKit poolKit)
                   throws DAValidateException,
DAException

Saves the Bundle and adds the relation with the skills and skill divisions.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Returns:

the saved Bundle id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

deleteSkills

protected void deleteSkills(Bundle bundle,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Deletes all the existing relation between the skills and the given Bundle.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

deleteSkillDivisions

protected void deleteSkillDivisions(Bundle bundle,
 PoolKit poolKit)
                             throws DAValidateException,
DAException

Deletes all the existing relation between the skill divisions and the given Bundle.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

insertSkill

protected Long insertSkill(BOBundleSkill bundleSkill,
 PoolKit poolKit)
                    throws DAValidateException,
DAException

Inserts the relation between the current Bundle and a skill.

Parameters:

bundleSkill - the BOBundleSkill

poolKit - the PoolKit

Returns:

the inserted BOBundleSkill id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

insertSkillDivision

protected Long insertSkillDivision(BOBundleSkillDivision bundleSkillDivision,
 PoolKit poolKit)
                            throws DAValidateException,
DAException

Inserts the relation between the current Bundle and a skill division.

Parameters:

bundleSkillDivision - the BOBundleSkillDivision

poolKit - the PoolKit

Returns:

the inserted BOBundleSkillDivision id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

notifyBundleOperation

protected void notifyBundleOperation(BOBundleOperation bundleOperation,
 PoolKit poolKit)
                              throws DAValidateException,
DAException

Notifies the addition of the given BOBundleOperation.

Parameters:

bundleOperation - the BOBundleOperation

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.