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

Class BTBundleAttributesCalculate

java.lang.Object

overit.geocall.bl.BusinessTask<BundleAttributesCalculateEvent>

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

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

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

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(BundleAttributesCalculateEvent.class)
public class BTBundleAttributesCalculate
extends BTBundler<BundleAttributesCalculateEvent>

Business task in order to calculate a BOBundleHeader attributes.
When the BundleAttributesCalculateEvent is launched the BT notices the call and calculates the BOBundleHeader attributes basing on the event's input.

Since:

10.1

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTBundleAttributesCalculate()

Method Summary

Modifier and Type	Method	Description
protected void	calculateSchedulingAttributes(Bundle bundle, List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Calculates the scheduling attributes for the current Bundle.
protected void	checkFinalMaxTeamCardinality(Bundle bundle)	Checks if the calculated maximum team cardinality of the Bundle is greater than the minimum one.
protected void	createBundleSkill(Bundle bundle, Long skillId, Long cardinality)	Creates a BOBundleSkill starting from the given skill and its cardinality.
protected void	createBundleSkill(Bundle bundle, BOSkillConfigurationSkill skillConfigurationSkill)	Creates a BOBundleSkill starting from the given BOSkillConfigurationSkill.
protected void	createBundleSkillDivision(Bundle bundle, BOSkillConfigurationDivision skillConfigurationDivision)	Creates a BOBundleSkillDivision starting from the given BOSkillConfigurationSkill.
protected void	createBundleSkillOverride(Bundle bundle, BOSkillOverrideConfigurationSkill skillOverrideConfigurationSkill)	Creates a BOBundleSkill starting from the given BOSkillOverrideConfigurationSkill.
protected void	createSkillAndSkillDivision(Bundle bundle, List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Creates the new BOBundleSkill list and BOBundleSkillDivision list for the Bundle.
protected void	createSkillAndSkillDivisionByConfiguration(Bundle bundle, Long skillConfigurationId, BundleEntitiesCache cache, PoolKit poolKit)	Starting from the BOSkillConfiguration, it creates all the skills and skill divisions for the current Bundle.
protected void	createSkillAndSkillDivisionByConfigurationOverride(Bundle bundle, Long skillOverrideConfigurationId, PoolKit poolKit)	Starting from the BOSkillOverrideConfiguration, it creates all the skills for the current Bundle.
protected void	execute(BundleAttributesCalculateEvent event, PoolKit poolKit)	Starting from the given BundleAttributesCalculateEvent input, it calculates the scheduling attributes for the current Bundle and creates the BOSkills and BOSkillDivisions.
protected Date	getBundleAppointmentEndDate(List<BOWorkOrderHeader> workOrders)	Returns the Bundle main appointment end date based on the list of related work orders.
protected Date	getBundleAppointmentStartDate(List<BOWorkOrderHeader> workOrders)	Returns the Bundle main appointment start date based on the list of related work orders.
protected Long	getBundleCardinality(List<BOWorkOrderOperation> woOperations)	Returns the Bundle cardinality based on the related list of BOWorkOrderOperations.
protected Long	getBundleDefaultDuration(List<BOWorkOrderOperation> woOperations, PoolKit poolKit)	Returns the Bundle default duration based on the related list of BOWorkOrderOperations.
protected Date	getBundleEndDate(List<BOWorkOrderHeader> workOrders)	Returns the Bundle end date based on the list of related work order.
protected String	getBundleMicrocluster(BOWorkOrderOperation woOperation, BundleEntitiesCache cache, PoolKit poolKit)	Returns the Bundle microcluster based on the BOAddress related to the given BOWorkOrderOperation.
protected Long	getBundleMinTimeForDay(List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Returns the bundle minimum time for day based on the related list of BOWorkOrderOperations.
protected Long	getBundleMinTimeForSuspension(List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Returns the bundle minimum time for suspension based on the related list of BOWorkOrderOperations.
protected Date	getBundleStartDate(List<BOWorkOrderHeader> workOrders)	Returns the Bundle start date based on the list of related work order.
protected Double	getBundleXCoordinate(BOWorkOrderOperation woOperation, BundleEntitiesCache cache, PoolKit poolKit)	Returns the Bundle X coordinate based on the BOAddress related to the given BOWorkOrderOperation.
protected Double	getBundleYCoordinate(BOWorkOrderOperation woOperation, BundleEntitiesCache cache, PoolKit poolKit)	Returns the Bundle Y coordinate based on the BOAddress related to the given BOWorkOrderOperation.
protected Stream<BOActivity>	getOperationActivities(List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Loads from the BundleEntitiesCache every BOActivity that is related to a BOWorkOrderOperation in the Bundle.
protected BOSkillOverrideConfiguration	getSkillOverrideConfiguration(Long skillOverrideConfigurationId, PoolKit poolKit)	Returns the BOSkillOverrideConfiguration which corresponds to the given id.
protected List<BOSkillOverrideConfigurationSkill>	getSkillOverrideConfigurationSkills(Long skillOverrideConfigurationId, PoolKit poolKit)	Returns the list of BOSkillOverrideConfigurationSkill filtering by the corresponding BOSkillOverrideConfiguration id.
protected BOAddress	getWorkOrderOperationAddress(BOWorkOrderOperation woOperation, BundleEntitiesCache cache, PoolKit poolKit)	Returns the BOAddress related to the given BOWorkOrderOperation.
protected boolean	isBundleBooking(List<BOWorkOrderHeader> workOrders, PoolKit poolKit)	Checks whether any of the BOWorkOrderHeader related to the current Bundle is considered as booking.
protected Boolean	isBundleMultiDay(List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Checks whether any of the BOActivity of the current Bundle extends on multiple days or not.
protected Boolean	isBundleOnCallExcluded(List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Checks whether any of the BOActivity of the current Bundle has on call resources and therefore it must be excluded.
protected Boolean	isBundleOnDutyOnly(List<BOWorkOrderOperation> woOperations, BundleEntitiesCache cache, PoolKit poolKit)	Checks whether any of the BOActivity of the current Bundle requires only resources that are currently on duty or not.
protected List<BOWorkOrderOperation>	loadWorkOrderOperations(Bundle bundle, PoolKit poolKit)	Loads the list of all the BOWorkOrderOperations related to the current Bundle.
protected void	resetSchedulingAttributes(Bundle bundle)	Resets the scheduling attributes of the current Bundle.
protected void	setBundleCardinalities(Bundle bundle, Long skillMin, Long skillMax)	Calculates the bundle cardinalities basing on the given skill cardinalities.
protected void	setBundleCardinalities(Bundle bundle, BOSkillConfiguration skillConfiguration)	Calculates the bundle cardinalities basing on the given BOSkillConfiguration.
protected void	setBundleCardinalitiesOverride(Bundle bundle, BOSkillOverrideConfiguration skillOverrideConfiguration)	Calculates the bundle cardinalities basing on the given BOSkillOverrideConfiguration.
protected void	setOperationsRequirements(Bundle bundle, List<BOWorkOrderOperation> woOperations, PoolKit poolKit)	Sets the aggregated requirements for the bundle based on all its operations.

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

BTBundleAttributesCalculate

public BTBundleAttributesCalculate()

Method Details

execute

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

Starting from the given BundleAttributesCalculateEvent input, it calculates the scheduling attributes for the current Bundle and creates the BOSkills and BOSkillDivisions.

Specified by:

execute in class ValidExecutionBusinessTask<BundleAttributesCalculateEvent>

Parameters:

event - the BundleAttributesCalculateEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

resetSchedulingAttributes

protected void resetSchedulingAttributes(Bundle bundle)

Resets the scheduling attributes of the current Bundle.

Parameters:

bundle - the current Bundle

loadWorkOrderOperations

protected List<BOWorkOrderOperation> loadWorkOrderOperations(Bundle bundle,
 PoolKit poolKit)
                                                      throws DAValidateException,
DAException

Loads the list of all the BOWorkOrderOperations related to the current Bundle.

Parameters:

bundle - the Bundle

poolKit - the PoolKit

Returns:

a list of BOWorkOrderOperation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

calculateSchedulingAttributes

protected void calculateSchedulingAttributes(Bundle bundle,
 List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)
                                      throws DAValidateException,
DAException

Calculates the scheduling attributes for the current Bundle.

Parameters:

bundle - the current Bundle

woOperations - list of BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

setOperationsRequirements

protected void setOperationsRequirements(Bundle bundle,
 List<BOWorkOrderOperation> woOperations,
 PoolKit poolKit)
                                  throws DAException,
DAValidateException

Sets the aggregated requirements for the bundle based on all its operations. This method loads all requirements from the operations and aggregates them at bundle level.

Parameters:

bundle - the Bundle

woOperations - list of the related BOWorkOrderOperation

poolKit - the PoolKit

Throws:

DAException - if database access fails

DAValidateException - if validation fails

getBundleCardinality

protected Long getBundleCardinality(List<BOWorkOrderOperation> woOperations)

Returns the Bundle cardinality based on the related list of BOWorkOrderOperations.

Parameters:

woOperations - list of the related BOWorkOrderOperation

Returns:

the bundle cardinality

getWorkOrderOperationAddress

protected BOAddress getWorkOrderOperationAddress(BOWorkOrderOperation woOperation,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Returns the BOAddress related to the given BOWorkOrderOperation.

Parameters:

woOperation - the given BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

the work order operation address

getBundleXCoordinate

protected Double getBundleXCoordinate(BOWorkOrderOperation woOperation,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Returns the Bundle X coordinate based on the BOAddress related to the given BOWorkOrderOperation.

Parameters:

woOperation - the given BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

the bundle X coordinate

getBundleYCoordinate

protected Double getBundleYCoordinate(BOWorkOrderOperation woOperation,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Returns the Bundle Y coordinate based on the BOAddress related to the given BOWorkOrderOperation.

Parameters:

woOperation - the given BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

the bundle Y coordinate

getBundleMicrocluster

protected String getBundleMicrocluster(BOWorkOrderOperation woOperation,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Returns the Bundle microcluster based on the BOAddress related to the given BOWorkOrderOperation.

Parameters:

woOperation - the given BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

the bundle microcluster

getBundleDefaultDuration

protected Long getBundleDefaultDuration(List<BOWorkOrderOperation> woOperations,
 PoolKit poolKit)
                                 throws DAValidateException,
DAException

Returns the Bundle default duration based on the related list of BOWorkOrderOperations.

Parameters:

woOperations - list of the related BOWorkOrderOperation

poolKit - the PoolKit

Returns:

the bundle default duration

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getOperationActivities

protected Stream<BOActivity> getOperationActivities(List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Loads from the BundleEntitiesCache every BOActivity that is related to a BOWorkOrderOperation in the Bundle.

Parameters:

woOperations - list of BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

the list of BOActivity

isBundleMultiDay

protected Boolean isBundleMultiDay(List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Checks whether any of the BOActivity of the current Bundle extends on multiple days or not.

Parameters:

woOperations - list of BOWorkOrderOperation of the Bundle

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

true if the bundle must be multi day, false otherwise

isBundleOnDutyOnly

protected Boolean isBundleOnDutyOnly(List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Checks whether any of the BOActivity of the current Bundle requires only resources that are currently on duty or not.

Parameters:

woOperations - list of BOWorkOrderOperation of the Bundle

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

true if the bundle must be "on duty only", false otherwise

isBundleOnCallExcluded

protected Boolean isBundleOnCallExcluded(List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Checks whether any of the BOActivity of the current Bundle has on call resources and therefore it must be excluded.

Parameters:

woOperations - list of BO work order operation elements

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

true if the bundle must be "on call excluded", false otherwise

getBundleMinTimeForDay

protected Long getBundleMinTimeForDay(List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Returns the bundle minimum time for day based on the related list of BOWorkOrderOperations.

Parameters:

woOperations - list of BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

the bundle minimum time for day

getBundleMinTimeForSuspension

protected Long getBundleMinTimeForSuspension(List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)

Returns the bundle minimum time for suspension based on the related list of BOWorkOrderOperations.

Parameters:

woOperations - list of BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Returns:

the bundle minimum time for suspension

getBundleStartDate

protected Date getBundleStartDate(List<BOWorkOrderHeader> workOrders)

Returns the Bundle start date based on the list of related work order.

Parameters:

workOrders - list of related work orders

Returns:

the bundle start date

getBundleEndDate

protected Date getBundleEndDate(List<BOWorkOrderHeader> workOrders)

Returns the Bundle end date based on the list of related work order.

Parameters:

workOrders - list of related work orders

Returns:

the bundle end date

isBundleBooking

protected boolean isBundleBooking(List<BOWorkOrderHeader> workOrders,
 PoolKit poolKit)
                           throws DAException,
DAValidateException

Checks whether any of the BOWorkOrderHeader related to the current Bundle is considered as booking.

Parameters:

workOrders - list of related BOWorkOrderHeaders

poolKit - the PoolKit

Returns:

true if is bundle is to be considered booking, false otherwise

Throws:

DAException

DAValidateException

getBundleAppointmentStartDate

protected Date getBundleAppointmentStartDate(List<BOWorkOrderHeader> workOrders)

Returns the Bundle main appointment start date based on the list of related work orders.

Parameters:

workOrders - list of related work orders

Returns:

the bundle appointment start date

getBundleAppointmentEndDate

protected Date getBundleAppointmentEndDate(List<BOWorkOrderHeader> workOrders)

Returns the Bundle main appointment end date based on the list of related work orders.

Parameters:

workOrders - list of related work orders

Returns:

the bundle appointment end date

checkFinalMaxTeamCardinality

protected void checkFinalMaxTeamCardinality(Bundle bundle)

Checks if the calculated maximum team cardinality of the Bundle is greater than the minimum one. If it is not, then the maximum is set equal to the minimum.

Parameters:

bundle - the current Bundle

createSkillAndSkillDivision

protected void createSkillAndSkillDivision(Bundle bundle,
 List<BOWorkOrderOperation> woOperations,
 BundleEntitiesCache cache,
 PoolKit poolKit)
                                    throws DAValidateException,
DAException

Creates the new BOBundleSkill list and BOBundleSkillDivision list for the Bundle.

Parameters:

bundle - the Bundle

woOperations - list of the related BOWorkOrderOperation

cache - the BundleEntitiesCache

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

createSkillAndSkillDivisionByConfiguration

protected void createSkillAndSkillDivisionByConfiguration(Bundle bundle,
 Long skillConfigurationId,
 BundleEntitiesCache cache,
 PoolKit poolKit)
                                                   throws DAValidateException,
DAException

Starting from the BOSkillConfiguration, it creates all the skills and skill divisions for the current Bundle.

Parameters:

bundle - the current Bundle

skillConfigurationId - the BOActivitySkillConfiguration id

cache - the BundleEntitiesCache

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

setBundleCardinalities

protected void setBundleCardinalities(Bundle bundle,
 BOSkillConfiguration skillConfiguration)

Calculates the bundle cardinalities basing on the given BOSkillConfiguration.

Parameters:

bundle - the current Bundle

skillConfiguration - the considered BOSkillConfiguration

createBundleSkill

protected void createBundleSkill(Bundle bundle,
 BOSkillConfigurationSkill skillConfigurationSkill)

Creates a BOBundleSkill starting from the given BOSkillConfigurationSkill.

Parameters:

bundle - the current Bundle

skillConfigurationSkill - the given BOSkillConfigurationSkill.

createBundleSkillDivision

protected void createBundleSkillDivision(Bundle bundle,
 BOSkillConfigurationDivision skillConfigurationDivision)

Creates a BOBundleSkillDivision starting from the given BOSkillConfigurationSkill.

Parameters:

bundle - Bundle

skillConfigurationDivision - the given BOSkillConfigurationSkill.

createSkillAndSkillDivisionByConfigurationOverride

protected void createSkillAndSkillDivisionByConfigurationOverride(Bundle bundle,
 Long skillOverrideConfigurationId,
 PoolKit poolKit)
                                                           throws DAValidateException,
DAException

Starting from the BOSkillOverrideConfiguration, it creates all the skills for the current Bundle.

Parameters:

bundle - the current Bundle

skillOverrideConfigurationId - the BOSkillOverrideConfiguration id

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getSkillOverrideConfiguration

protected BOSkillOverrideConfiguration getSkillOverrideConfiguration(Long skillOverrideConfigurationId,
 PoolKit poolKit)
                                                              throws DAValidateException,
DAException

Returns the BOSkillOverrideConfiguration which corresponds to the given id.

Parameters:

skillOverrideConfigurationId - the BOSkillOverrideConfiguration id

poolKit - the PoolKit

Returns:

the corresponding BOSkillOverrideConfiguration

Throws:

DAValidateException

DAException

setBundleCardinalitiesOverride

protected void setBundleCardinalitiesOverride(Bundle bundle,
 BOSkillOverrideConfiguration skillOverrideConfiguration)

Calculates the bundle cardinalities basing on the given BOSkillOverrideConfiguration.

Parameters:

bundle - the current Bundle

skillOverrideConfiguration - the considered BOSkillOverrideConfiguration

getSkillOverrideConfigurationSkills

protected List<BOSkillOverrideConfigurationSkill> getSkillOverrideConfigurationSkills(Long skillOverrideConfigurationId,
 PoolKit poolKit)
                                                                               throws DAValidateException,
DAException

Returns the list of BOSkillOverrideConfigurationSkill filtering by the corresponding BOSkillOverrideConfiguration id.

Parameters:

skillOverrideConfigurationId - the BOSkillOverrideConfiguration id

poolKit - the PoolKit

Returns:

the list of BOSkillOverrideConfigurationSkill

Throws:

DAValidateException

DAException

createBundleSkillOverride

protected void createBundleSkillOverride(Bundle bundle,
 BOSkillOverrideConfigurationSkill skillOverrideConfigurationSkill)

Creates a BOBundleSkill starting from the given BOSkillOverrideConfigurationSkill.

Parameters:

bundle - the current Bundle

skillOverrideConfigurationSkill - the given BOSkillOverrideConfigurationSkill.

setBundleCardinalities

protected void setBundleCardinalities(Bundle bundle,
 Long skillMin,
 Long skillMax)

Calculates the bundle cardinalities basing on the given skill cardinalities.

Parameters:

bundle - the current Bundle

skillMin - the skill min cardinality

skillMax - the skill max cardinality

createBundleSkill

protected void createBundleSkill(Bundle bundle,
 Long skillId,
 Long cardinality)

Creates a BOBundleSkill starting from the given skill and its cardinality.

Parameters:

bundle - the current Bundle

skillConfigurationSkill - the given BOSkillConfigurationSkill.