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

Class BTBundleHeaderStatusUpdate

java.lang.Object

overit.geocall.bl.BusinessTask<BundleHeaderStatusUpdateEvent>

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

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

overit.geocallapp.wfm.bundler.bl.header.task.BTBundleHeaderStatusUpdate

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(BundleHeaderStatusUpdateEvent.class)
public class BTBundleHeaderStatusUpdate
extends BTBundler<BundleHeaderStatusUpdateEvent>

Business task in order to update the status of a BOBundleHeader.
When the BundleHeaderStatusUpdateEvent is launched the BT notices the call and updates the status of the BOBundleHeader basing on the event's input and the related rules.

Error Code:

• Codes.Bundler.INVALID_NEW_STATE
• Codes.Bundler.STATE_NOT_EDITABLE

Since:

10.1

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTBundleHeaderStatusUpdate()

Method Summary

Modifier and Type	Method	Description
protected void	checkValidStatus(Long newStatus, Long oldStatus)	Checks whether the Bundle status change is permitted and therefore if the update can be executed or not.
protected void	execute(BundleHeaderStatusUpdateEvent event, PoolKit poolKit)	Updates the BOBundleHeader only if the given BundleHeaderStatusUpdateInput contains a permitted change of status.
protected Bundle	loadBundle(Long bundleId, PoolKit poolKit)	Loads the Bundle related to the given id.
protected void	notifyStatusChange(Bundle bundle, PoolKit poolKit)	Notifies the BundleHeaderStatusUpdateEvent by calling the BundleNotificationEvent.
protected HashMap<String,Object>	prepareFilterData(BundleHeaderStatusUpdateInput input)	Prepares the filter in order to correctly load the BOBundleHeader to update.
protected HashMap<String,Object>	prepareUpdateData(BundleHeaderStatusUpdateInput input)	Prepares the data to update, i.e. the value of the new status for the BOBundleHeader.
protected void	update(BundleHeaderStatusUpdateInput input, PoolKit poolKit)	Performs the update of the BOBundleHeader with the validated change of status.

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

BTBundleHeaderStatusUpdate

public BTBundleHeaderStatusUpdate()

Method Details

execute

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

Updates the BOBundleHeader only if the given BundleHeaderStatusUpdateInput contains a permitted change of status.

Specified by:

execute in class ValidExecutionBusinessTask<BundleHeaderStatusUpdateEvent>

Parameters:

event - the BundleHeaderStatusUpdateEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

update

protected void update(BundleHeaderStatusUpdateInput input,
 PoolKit poolKit)
               throws DAException,
DAValidateException

Performs the update of the BOBundleHeader with the validated change of status.

Parameters:

input - the given BundleHeaderStatusUpdateInput containing all the needed bundle header data

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

checkValidStatus

protected void checkValidStatus(Long newStatus,
 Long oldStatus)
                         throws DAValidateException

Checks whether the Bundle status change is permitted and therefore if the update can be executed or not.

Parameters:

newStatus - the new bundle status, it cannot be null

oldStatus - the old bundle status

Throws:

DAValidateException - the DA validate exception

prepareFilterData

protected HashMap<String,Object> prepareFilterData(BundleHeaderStatusUpdateInput input)

Prepares the filter in order to correctly load the BOBundleHeader to update.

Parameters:

input - the BundleHeaderStatusUpdateInput

Returns:

the hash map that is going to be used as filter

prepareUpdateData

protected HashMap<String,Object> prepareUpdateData(BundleHeaderStatusUpdateInput input)

Prepares the data to update, i.e. the value of the new status for the BOBundleHeader.

Parameters:

input - the BundleHeaderStatusUpdateInput

Returns:

the hash map that is going to be used to update the bundle status

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

notifyStatusChange

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

Notifies the BundleHeaderStatusUpdateEvent by calling the BundleNotificationEvent.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Throws:

DAException

DAValidateException