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

Class BTBundling

java.lang.Object

overit.geocall.bl.BusinessTask<BundlingEvent>

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

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

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

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(BundlingEvent.class)
public class BTBundling
extends BTBundler<BundlingEvent>

Business task that implements all the phases of the Bundle creation process.
When the BundlingEvent is launched the BT notices the call and performs several actions:

• it selects the list of needed BOWorkOrderOperation by calling BundlingOperationSelectEvent
• it validates the selected BOWorkOrderOperation by checking their state
• it creates a new Bundle with the selected BOWorkOrderOperation by calling BundleCreateEvent

Required fields, at least:

• one work order operation id

or

• a Primary Bundling Criteria

Permission:

• BundlerPermissions.MANUAL_CREATION_EXECUTE
• BundlerPermissions.BUNDLING_PROCESS_EDIT

Error Code:

• Codes.OPERATION_NOT_PERMITTED
• Codes.Bundler.NO_SAME_EXECUTION_TYPE
• Codes.Bundler.INVALID_BUNDLING_RULE
• Codes.Bundler.NO_OPERATIONS_OR_CRITERIA_SPECIFIED
• Codes.Bundler.INVALID_WO_OPERATIONS

Visibility:

• work order operations that belong to the same current user's operation center
• bundling rules that belong to the same current user's operation center

Since:

10.1

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected BundlerMessageHelper	bundlerMessageHelper
protected LogHelper	logHelper

Constructor Summary

Constructors

Constructor	Description
BTBundling()

Method Summary

Modifier and Type	Method	Description
protected Map<BOBundleCriterion,List<BOWorkOrderOperation>>	applyBundlingCriteria(BundlingInput bundlingInput, BundlingRule rule, List<BOWorkOrderOperation> woOperations, PoolKit poolKit)	Applies the bundling criteria.
protected String	buildBundleName(BundlingInput bundlingInput, BOBundleCriterion bundleCriterion, PoolKit poolKit)	Builds the bundle name starting from the given template and the bundling input.
protected void	checkInputParameters(BundlingInput input)	Checks the bundling input parameters.
protected void	checkUserPermission(BundlingInput input)	Checks whether the current BOUser has the permission to create a bundle.
protected Long	createBundle(BOBundleCriterion bundleCriterion, List<BOWorkOrderOperation> woOperations, BundlingInput bundlingInput, PoolKit poolKit)	Creates a new Bundle with all obtained characteristics by calling BundleCreateEvent.
protected List<Long>	createBundlesByCriterion(BundlingRule rule, BOBundleCriterion bundleCriterion, List<BOWorkOrderOperation> workOrderOperations, BundlingInput bundlingInput, PoolKit poolKit)	Creates the Bundles starting from the given BOBundleCriterion and the list of BOWorkOrderOperation to aggregate.
protected void	execute(BundlingEvent event, PoolKit poolKit)	Starting from a list of given BundlingRules, it tries to create as many Bundle that meet the requirements.
protected Long	getMaxBundleDuration(BOBundlingRuleHeader bundlingRuleHeader)	Returns the max bundle duration set in the BOBundlingRuleHeader.
protected int	getMaxBundleSize(BOBundlingRuleHeader bundlingRuleHeader)	Returns the max bundle size set in the BOBundlingRuleHeader.
protected int	getMinBundleSize(BOBundlingRuleHeader bundlingRuleHeader)	Returns the min bundle size set in the BOBundlingRuleHeader.
protected List<BOWorkOrderOperation>	getWorkOrderOperations(BundlingInput input, BundlingRule rule, PoolKit poolKit)	Returns the sorted list of all the BOWorkOrderOperations that are valid for the aggregation.
protected void	initializeCache(List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Initializes the BundleEntitiesCache with the BOWorkOrderOperations appointments.
protected void	initializeLog(BundlingInput input)	Initializes the log for the current process.
protected Long	insertBundleCriterion(BOBundleCriterion bundleCriterion, PoolKit poolKit)	Inserts the given BOBundleCriterion.
protected List<BOWorkOrderOperation>	loadWorkOrderOperations(BundlingRule rule, List<Long> workOrderOperationIds, BundleEntitiesCache cache, PoolKit poolKit)	Loads the list of BOWorkOrderOperation from the given input, using also the work order filters set on the BundlingRule
protected List<List<BOWorkOrderOperation>>	partitionBundleWorkOrderOperations(BundlingRule rule, List<BOWorkOrderOperation> workOrderOperations)	If a maximum size was previously selected, it divides the list of BOWorkOrderOperation into different sized list.
protected List<Long>	processBundlingRule(BundlingInput input, BundlingRule rule, PoolKit poolKit)	Creates the bundles starting from the given BundlingRule and the BundlingInput.
protected List<BOWorkOrderOperation>	sortWorkOrderOperations(List<BOWorkOrderOperation> woOperations, BundlingRule bundlingRule, BundlingInput input, PoolKit poolKit)	Sorts the list of 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

logHelper

protected LogHelper logHelper

bundlerMessageHelper

protected BundlerMessageHelper bundlerMessageHelper

Constructor Details

BTBundling

public BTBundling()

Method Details

execute

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

Starting from a list of given BundlingRules, it tries to create as many Bundle that meet the requirements. Finally, it writes the set of just created BOBundleHeader id into the event journal.

Specified by:

execute in class ValidExecutionBusinessTask<BundlingEvent>

Parameters:

event - the BundlingEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

initializeLog

protected void initializeLog(BundlingInput input)
                      throws DAValidateException,
DAException

Initializes the log for the current process.

Parameters:

input - the BundlingInput

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

processBundlingRule

protected List<Long> processBundlingRule(BundlingInput input,
 BundlingRule rule,
 PoolKit poolKit)
                                  throws DAException,
DAValidateException

Creates the bundles starting from the given BundlingRule and the BundlingInput.

Parameters:

input - the BundlingInput

rule - the BundlingRule

poolKit - the PoolKit

Returns:

a list of Bundle id created

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getWorkOrderOperations

protected List<BOWorkOrderOperation> getWorkOrderOperations(BundlingInput input,
 BundlingRule rule,
 PoolKit poolKit)
                                                     throws DAValidateException,
DAException

Returns the sorted list of all the BOWorkOrderOperations that are valid for the aggregation.

Parameters:

input - the BundlingInput

rule - the BundlingRule

poolKit - the PoolKit

Returns:

a list of valid and sorted BOWorkOrderOperations

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

checkUserPermission

protected void checkUserPermission(BundlingInput input)
                            throws DAValidateException

Checks whether the current BOUser has the permission to create a bundle.

Parameters:

input - the BundlingInput

Throws:

DAValidateException - the DA validate exception when the user has not the right permission

checkInputParameters

protected void checkInputParameters(BundlingInput input)
                             throws DAValidateException

Checks the bundling input parameters.

Parameters:

input - the BundlingInput

Throws:

DAValidateException - the DA validate exception

loadWorkOrderOperations

protected List<BOWorkOrderOperation> loadWorkOrderOperations(BundlingRule rule,
 List<Long> workOrderOperationIds,
 BundleEntitiesCache cache,
 PoolKit poolKit)
                                                      throws DAValidateException,
DAException

Loads the list of BOWorkOrderOperation from the given input, using also the work order filters set on the BundlingRule

Parameters:

rule - the BundlingRule

workOrderOperationIds - list of work order operation ids

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

the list of the loaded BOWorkOrderOperations

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

initializeCache

protected void initializeCache(List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Initializes the BundleEntitiesCache with the BOWorkOrderOperations appointments.

Parameters:

woOperations - list of BOWorkOrderOperation elements

cache - the BundleEntitiesCache

poolKit - the PoolKit

sortWorkOrderOperations

protected List<BOWorkOrderOperation> sortWorkOrderOperations(List<BOWorkOrderOperation> woOperations,
 BundlingRule bundlingRule,
 BundlingInput input,
 PoolKit poolKit)
                                                      throws DAValidateException,
DAException

Sorts the list of BOWorkOrderOperation.

Parameters:

woOperations - list of BOWorkOrderOperation to sort

bundlingRule - the BundlingRule

input - the BundlingInput

poolKit - the PoolKit

Returns:

the BOWorkOrderOperation ordered list

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

applyBundlingCriteria

protected Map<BOBundleCriterion,List<BOWorkOrderOperation>> applyBundlingCriteria(BundlingInput bundlingInput,
 BundlingRule rule,
 List<BOWorkOrderOperation> woOperations,
 PoolKit poolKit)
                                                                           throws DAValidateException,
DAException

Applies the bundling criteria.

Parameters:

bundlingInput - the bundling input

rule - the BundlingRule

woOperations - list of BOWorkOrderOperation

poolKit - the PoolKit

Returns:

a map of BOWorkOrderOperations grouped by the corresponding BOBundleCriterion

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

createBundlesByCriterion

protected List<Long> createBundlesByCriterion(BundlingRule rule,
 BOBundleCriterion bundleCriterion,
 List<BOWorkOrderOperation> workOrderOperations,
 BundlingInput bundlingInput,
 PoolKit poolKit)
                                       throws DAValidateException,
DAException

Creates the Bundles starting from the given BOBundleCriterion and the list of BOWorkOrderOperation to aggregate.

Parameters:

rule - the BundlingRule

bundleCriterion - the BOBundleCriterion

workOrderOperations - list of BOWorkOrderOperation to aggregate

bundlingInput - the BundlingInput

poolKit - the PoolKit

Returns:

a list of created Bundle ids

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

insertBundleCriterion

protected Long insertBundleCriterion(BOBundleCriterion bundleCriterion,
 PoolKit poolKit)
                              throws DAValidateException,
DAException

Inserts the given BOBundleCriterion.

Parameters:

bundleCriterion - the BOBundleCriterion to insert

poolKit - the PoolKit

Returns:

the BOBundleCriterion id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

partitionBundleWorkOrderOperations

protected List<List<BOWorkOrderOperation>> partitionBundleWorkOrderOperations(BundlingRule rule,
 List<BOWorkOrderOperation> workOrderOperations)

If a maximum size was previously selected, it divides the list of BOWorkOrderOperation into different sized list.

Parameters:

rule - the BundlingRule

workOrderOperations - list ofBOWorkOrderOperation

Returns:

a list of BOWorkOrderOperation lists of different size

getMinBundleSize

protected int getMinBundleSize(BOBundlingRuleHeader bundlingRuleHeader)

Returns the min bundle size set in the BOBundlingRuleHeader.

Parameters:

bundlingRuleHeader - the BOBundlingRuleHeader

Returns:

the min bundle size

getMaxBundleSize

protected int getMaxBundleSize(BOBundlingRuleHeader bundlingRuleHeader)

Returns the max bundle size set in the BOBundlingRuleHeader.

Parameters:

bundlingRuleHeader - the BOBundlingRuleHeader

Returns:

the max bundle size

getMaxBundleDuration

protected Long getMaxBundleDuration(BOBundlingRuleHeader bundlingRuleHeader)

Returns the max bundle duration set in the BOBundlingRuleHeader.

Parameters:

bundlingRuleHeader - the BOBundlingRuleHeader

Returns:

the max bundle duration

createBundle

protected Long createBundle(BOBundleCriterion bundleCriterion,
 List<BOWorkOrderOperation> woOperations,
 BundlingInput bundlingInput,
 PoolKit poolKit)
                     throws DAValidateException,
DAException

Creates a new Bundle with all obtained characteristics by calling BundleCreateEvent.

Parameters:

bundleCriterion - the BOBundleCriterion

woOperations - list of BOWorkOrderOperation we want to aggregate into the new Bundle

bundlingInput - the BundlingInput

poolKit - the PoolKit

Returns:

the id of the created BOBundleHeader

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

buildBundleName

protected String buildBundleName(BundlingInput bundlingInput,
 BOBundleCriterion bundleCriterion,
 PoolKit poolKit)

Builds the bundle name starting from the given template and the bundling input. If a template is not provided, a default one is used, which is composed by the execution type and the bundling rule name and the current date.

Parameters:

bundlingInput - the BundlingInput

bundleCriterion - the BOBundleCriterion

poolKit - the PoolKit

Returns:

the bundle name