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

Class BTBundleOperationCancel

java.lang.Object

overit.geocall.bl.BusinessTask<BundleOperationCancelEvent>

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

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

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

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(BundleOperationCancelEvent.class)
public class BTBundleOperationCancel
extends BTBundler<BundleOperationCancelEvent>

Business task in order to cancel a BOBundleOperation.
When the BundleOperationCancelEvent is launched the BT notices the call and cancels the BOBundleOperation basing on the event's input.

Required fields:

• bundle operation id

Permission:

• BundlerPermissions.BUNDLE_EDIT

Error Code:

• Codes.OPERATION_NOT_PERMITTED: Operation not allowed
• Codes.Bundler.BUNDLE_NOT_SCHEDULABLE
• Codes.Bundler.BUNDLE_OPERATIONS_NOT_FOUND_IN_BUNDLE
• Codes.Bundler.BUNDLE_OPERATIONS_NOT_SCHEDULABLE

Visibility:

• active bundle operations that belongs to the specified bundle
• work order operations associated to the specified bundle
• appointment associated to the specified bundle operation
• skill and skill division associated to the specified bundle

Since:

11.0

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTBundleOperationCancel()

Method Summary

Modifier and Type	Method	Description
protected void	calculateBundleAttributes(Bundle bundle, PoolKit poolKit)	Calculates all the Bundle attributes.
protected void	cancelBundleOperations(Bundle bundle, Collection<BOBundleOperation> bundleOperations, PoolKit poolKit)	Cancels the given BOBundleOperations, unlinks the related BOAppointment, recalculates the links between the remaining BOBundleOperations and finally updates the related Bundle.
protected void	changeBundleOperationStatus(BOBundleOperation bundleOperation, PoolKit poolKit)	Updates the status of the given BOBundleOperation to BOBundleOperationStatus.Values.CANCELLED.
protected void	checkUserPermission()	Checks if the user has the required permission.
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(BundleOperationCancelEvent event, PoolKit poolKit)	Cancels the specified BOBundleOperation associated to the given Bundle.
protected WorkOrdersIntegrationService	getIntegrationService(PoolKit poolKit)	Retrieves the WorkOrdersIntegrationService instance.
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(List<Long> woOperationIds, PoolKit poolKit)	Creates the new links between the given the BOWorkOrderOperations.
protected Bundle	loadBundle(Long bundleId, PoolKit poolKit)	Loads the Bundle related to the given id.
protected List<BOBundleOperation>	loadBundleOperations(Bundle bundle, Collection<Long> bundleOperations, PoolKit poolKit)	Loads the BOBundleOperations from the Bundle.
protected List<BOWorkOrderOperation>	loadWorkOrderOperations(List<Long> ids, PoolKit poolKit)	Loads all the BOWorkOrderOperations related to the give list of ids.
protected void	notifyBundleOperationCancel(BOBundleOperation bundleOperation, PoolKit poolKit)	Notifies the cancellation of the given BOBundleOperation.
protected void	recalculateLinks(Bundle bundle, Collection<BOBundleOperation> bundleOperations, PoolKit poolKit)	Recalculates the links of the remaining BOBundleOperations.
protected Long	saveBundle(Bundle bundle, PoolKit poolKit)	Saves the Bundle and adds the relation with the skills and skill divisions.
protected void	unbundle(Bundle bundle, PoolKit poolKit)	Unbundles the specified Bundle.
protected void	unlinkWorkOrderOperations(Bundle bundle, PoolKit poolKit)	Unlinks all the BOWorkOrderOperations associated to the given Bundle.
protected void	updateBundle(Bundle bundle, PoolKit poolKit)	Updates the Bundle, recalculates all its attributes, including the skills and skill divisions.
protected void	updateHeader(BOBundleHeader bundleHeader, PoolKit poolKit)	Updates the given BOBundleHeader.
protected void	validate(Bundle bundle, Collection<BOBundleOperation> bundleOperations)	Checks if the bundle state is BOBundleStatus.Values.SCHEDULABLE and if the operations are found on the Bundle.

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

BTBundleOperationCancel

public BTBundleOperationCancel()

Method Details

execute

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

Cancels the specified BOBundleOperation associated to the given Bundle.

Specified by:

execute in class ValidExecutionBusinessTask<BundleOperationCancelEvent>

Parameters:

event - the BundleOperationCancelEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

checkUserPermission

protected void checkUserPermission()
                            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

loadBundleOperations

protected List<BOBundleOperation> loadBundleOperations(Bundle bundle,
 Collection<Long> bundleOperations,
 PoolKit poolKit)
                                                throws DAValidateException,
DAException

Loads the BOBundleOperations from the Bundle.

Parameters:

bundle - the Bundle

bundleOperations - the bundleOperations

poolKit - the PoolKit

Returns:

collection of BOBundleOperations found in the bundle

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

validate

protected void validate(Bundle bundle,
 Collection<BOBundleOperation> bundleOperations)
                 throws DAValidateException

Checks if the bundle state is BOBundleStatus.Values.SCHEDULABLE and if the operations are found on the Bundle. and if the operations state is BOBundleOperationStatus.Values.SCHEDULABLE.

Parameters:

bundle - the Bundle

bundleOperations - the BOBundleOperations

Throws:

DAValidateException - the DA validate exception

unbundle

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

Unbundles the specified Bundle.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

cancelBundleOperations

protected void cancelBundleOperations(Bundle bundle,
 Collection<BOBundleOperation> bundleOperations,
 PoolKit poolKit)
                               throws DAValidateException,
DAException

Cancels the given BOBundleOperations, unlinks the related BOAppointment, recalculates the links between the remaining BOBundleOperations and finally updates the related Bundle.

Parameters:

bundle - the Bundle

bundleOperations - the BOBundleOperations

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

changeBundleOperationStatus

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

Updates the status of the given BOBundleOperation to BOBundleOperationStatus.Values.CANCELLED.

Parameters:

bundleOperation - the BOBundleOperation

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

recalculateLinks

protected void recalculateLinks(Bundle bundle,
 Collection<BOBundleOperation> bundleOperations,
 PoolKit poolKit)
                         throws DAValidateException,
DAException

Recalculates the links of the remaining BOBundleOperations.

Parameters:

bundle - the Bundle

bundleOperations - the BOBundleOperations

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 all the BOWorkOrderOperations associated to the given Bundle.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadWorkOrderOperations

protected List<BOWorkOrderOperation> loadWorkOrderOperations(List<Long> ids,
 PoolKit poolKit)
                                                      throws DAValidateException,
DAException

Loads all the BOWorkOrderOperations related to the give list of ids.

Parameters:

ids - list of BOWorkOrderOperations

poolKit - the PoolKit

Returns:

a list of loaded BOWorkOrderOperations

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

linkWorkOrderOperations

protected void linkWorkOrderOperations(List<Long> woOperationIds,
 PoolKit poolKit)
                                throws DAValidateException,
DAException

Creates the new links between the given the BOWorkOrderOperations.

Parameters:

woOperationIds - list of BOWorkOrderOperation ids

poolKit - the PoolKit

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

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

calculateBundleAttributes

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

Calculates all the Bundle attributes.

Parameters:

bundle - the 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

updateHeader

protected void updateHeader(BOBundleHeader bundleHeader,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Updates the given BOBundleHeader.

Parameters:

bundleHeader - the BOBundleHeader

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

notifyBundleOperationCancel

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

Notifies the cancellation 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.