Package overit.geocallapp.wfm.bundler.bl.task

Class BTBundleLock

java.lang.Object

overit.geocall.bl.BusinessTask<BundleLockEvent>

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

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

overit.geocallapp.wfm.bundler.bl.task.BTBundleLock

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(BundleLockEvent.class)
public class BTBundleLock
extends BTBundler<BundleLockEvent>

Business task in order to lock a list of Bundles.
When the BundleLockEvent is launched the BT notices the call and locks the Bundles basing on the event's input.

Required fields:

• list of bundle ids

Permission:

• BundlerPermissions.BUNDLE_EDIT

Error Code:

• Codes.OPERATION_NOT_PERMITTED: Operation not allowed
• Codes.Bundler.BUNDLE_CANCELLED_OR_CLOSED

Visibility:

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

Since:

11.0

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTBundleLock()

Method Summary

Modifier and Type	Method	Description
protected void	checkUserPermission()	Checks whether the current user has the permission to edit the Bundle.
protected void	execute(BundleLockEvent event, PoolKit poolKit)	Locks the given Bundles by calling the BundleHeaderLockedUpdateEvent.
protected BOBundleHeader	loadBundleHeader(PoolKit poolKit, Long bundleId)	Loads the BOBundleHeader related to the given id.
protected void	lockBundle(BOBundleHeader header, PoolKit poolKit)	Performs the update of the BOBundleHeader by locking it.

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

BTBundleLock

public BTBundleLock()

Method Details

execute

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

Locks the given Bundles by calling the BundleHeaderLockedUpdateEvent.

Specified by:

execute in class ValidExecutionBusinessTask<BundleLockEvent>

Parameters:

event - the BundleUnlockEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadBundleHeader

protected BOBundleHeader loadBundleHeader(PoolKit poolKit,
 Long bundleId)
                                   throws DAValidateException,
DAException

Loads the BOBundleHeader related to the given id.

Parameters:

poolKit - the PoolKit

bundleId - the Bundle id

Returns:

the loaded BOBundleHeader

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

lockBundle

protected void lockBundle(BOBundleHeader header,
 PoolKit poolKit)
                   throws DAValidateException,
DAException

Performs the update of the BOBundleHeader by locking it.

Parameters:

header - the current BOBundleHeader

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 edit the Bundle.

Throws:

DAValidateException - the DA validate exception