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

Class BTUnbundling

java.lang.Object

overit.geocall.bl.BusinessTask<UnbundlingEvent>

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

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

overit.geocallapp.wfm.orchestrator.workorders.bl.bundler.bundling.task.BTUnbundling

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(UnbundlingEvent.class)
public class BTUnbundling
extends BTBundler<UnbundlingEvent>

Business task in order to cancel a list of given Bundle with all their BOBundleOperations. When a BOBundleOperation is cancelled, its status becomes BOBundleOperationStatus.Values.CANCELLED and the link with the related BOWorkOrderOperation is broken.
When the UnbundlingEvent is launched the BT notices the call and performs the cancellation for every Bundle within the list that is in BOBundleStatus.Values.SCHEDULABLE status.

Required fields:

• a list of bundle id

Permission:

• BundlerPermissions.UNBUNDLING_EXECUTE

Error Code:

• Codes.OPERATION_NOT_PERMITTED
• Codes.Bundler.BUNDLE_ALREADY_CANCELLED
• Codes.Bundler.ONLY_SCHEDULABLE_BUNDLES_CAN_BE_CANCELLED
• Codes.Bundler.BUNDLE_LOCKED

Visibility:

• bundling operations that belong to the same current user's operation center
• appointment associated to the specified bundle operation

Since:

10.1

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected static final LogChannel	LOG

Constructor Summary

Constructors

Constructor	Description
BTUnbundling()

Method Summary

Modifier and Type	Method	Description
protected void	cancelBundleOperations(Bundle bundle, PoolKit poolKit)	Cancels all the not yet cancelled BOBundleOperation by changing their status and breaking the link between them and the related BOWorkOrderOperation.
protected void	changeBundleOperationsStatus(BOBundleOperation bundleOperation, PoolKit poolKit)	Changes the status of every BOBundleOperation to BOBundleOperationStatus.Values.CANCELLED by calling BundleOperationStatusUpdateEvent.
protected boolean	checkBundleStatusSchedulable(Bundle bundle)	Checks if current Bundle status is BOBundleStatus.Values.SCHEDULABLE in order to permit the unbundling.
protected void	checkUserPermission()	Checks whether the current user has the permission to create/cancel a Bundle.
protected void	execute(UnbundlingEvent event, PoolKit poolKit)	Executes the unbundling process for the all given Bundles that are BOBundleStatus.Values.SCHEDULABLE, by calling the canceling process on all the related BOBundleOperation.
protected Bundle	loadBundle(Long bundleId, PoolKit poolKit)	Loads the Bundle related to the given id.
protected void	notifyUnbundling(Bundle bundle, PoolKit poolKit)	Notifies the unbundling process by calling BundleNotificationEvent with BundleNotificationAction.UNBUNDLE action.
protected void	unlinkBundleOperations(List<BOBundleOperation> bundleOperationList, PoolKit poolKit)	Removes the link between the list of current BOBundleOperation and each related BOWorkOrderOperation.

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

Field Details

LOG

protected static final LogChannel LOG

Constructor Details

BTUnbundling

public BTUnbundling()

Method Details

execute

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

Executes the unbundling process for the all given Bundles that are BOBundleStatus.Values.SCHEDULABLE, by calling the canceling process on all the related BOBundleOperation.

Specified by:

execute in class ValidExecutionBusinessTask<UnbundlingEvent>

Parameters:

event - the UnbundlingEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadBundle

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

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

cancelBundleOperations

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

Cancels all the not yet cancelled BOBundleOperation by changing their status and breaking the link between them and the related BOWorkOrderOperation.

Parameters:

bundle - the current Bundle

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

changeBundleOperationsStatus

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

Changes the status of every BOBundleOperation to BOBundleOperationStatus.Values.CANCELLED by calling BundleOperationStatusUpdateEvent.

Parameters:

bundleOperation - the current BOBundleOperation

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

unlinkBundleOperations

protected void unlinkBundleOperations(List<BOBundleOperation> bundleOperationList,
 PoolKit poolKit)
                               throws DAValidateException,
DAException

Removes the link between the list of current BOBundleOperation and each related BOWorkOrderOperation.

Parameters:

bundleOperationList - current list of BOBundleOperation

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkUserPermission

protected void checkUserPermission()
                            throws DAValidateException

Checks whether the current user has the permission to create/cancel a Bundle.

Throws:

DAValidateException - the DA validate exception

checkBundleStatusSchedulable

protected boolean checkBundleStatusSchedulable(Bundle bundle)
                                        throws DAValidateException

Checks if current Bundle status is BOBundleStatus.Values.SCHEDULABLE in order to permit the unbundling. If the status is BOBundleStatus.Values.CANCELLED no exception is thrown, but the unbundling process is stopped.

Parameters:

bundle - the current Bundle

Returns:

true, if bundle status is schedulable

Throws:

DAValidateException - the DA validate exception

notifyUnbundling

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

Notifies the unbundling process by calling BundleNotificationEvent with BundleNotificationAction.UNBUNDLE action.

Parameters:

bundle - the list of Bundle

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception