Package overit.geocallapp.wfm.core.ux.schedule.tooltip.task

Class BTActivityTooltipBundlerLoad<E>

java.lang.Object

overit.geocall.bl.BusinessTask<E>

overit.geocallapp.wfm.core.ux.schedule.tooltip.task.BTActivityTooltipBundlerLoad<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

Serializable, Tool

Direct Known Subclasses:

BTAccountedActivityTooltipBundlerLoad, BTBundleTooltipDataLoad, BTPlannedActivityTooltipBundlerLoad

public abstract class BTActivityTooltipBundlerLoad<E>
extends BusinessTask<E>

Base implementation to build the tool-tip for the activities currently aggregated in an active Bundle.

Since:

10.1

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTActivityTooltipBundlerLoad()

Method Summary

Modifier and Type	Method	Description
protected void	addBundlerData(ActivityTooltipData tooltipData, PoolKit poolKit)	If the bundler module is active, it checks if the current activity is part of an active Bundle starting from its BOAppointment.
protected void	body(E event, PoolKit poolKit)	Builds the tool-tip for the current activity with its Bundle information.
protected abstract ActivityTooltipData	getActivityTooltipData(E event)	Abstract method which retrieves the activity tool-tip data starting from the specific event.
protected String	getBundleRelatedActivities(BundleEntitiesAggregate aggregate, PoolKit poolKit)	Returns the codes of the BOWorkOrderOperations related to the given Bundle.
protected String	getBundleState(BundleEntitiesAggregate aggregate, PoolKit poolKit)	Returns the description of the related BOBundleStatus.
protected String	getBundleWorkInterval(BundleEntitiesAggregate aggregate)	Returns the work interval of the given Bundle.
protected Bundle	loadBundle(Long bundleOperationId, PoolKit poolKit)	Loads the needed Bundle starting from the given BOBundleOperation id.
protected BundleEntitiesAggregate	loadBundleAggregate(Long bundleOperationId, PoolKit poolKit)	Loads the corresponding BundleEntitiesAggregate starting from the given BOBundleOperation id.
protected void	prepareData(ActivityTooltipData tooltipData, BundleEntitiesAggregate aggregate, PoolKit poolKit)	Prepares the data to be displayed in the tool-tip.

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

BTActivityTooltipBundlerLoad

public BTActivityTooltipBundlerLoad()

Method Details

getActivityTooltipData

protected abstract ActivityTooltipData getActivityTooltipData(E event)

Abstract method which retrieves the activity tool-tip data starting from the specific event.

Parameters:

event - the specific event

Returns:

the activity tool-tip data

body

protected void body(E event,
 PoolKit poolKit)
             throws DAException,
DAValidateException

Builds the tool-tip for the current activity with its Bundle information.

Specified by:

body in class BusinessTask<E>

Parameters:

event - the specific event

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

addBundlerData

protected void addBundlerData(ActivityTooltipData tooltipData,
 PoolKit poolKit)
                       throws DAException,
DAValidateException

If the bundler module is active, it checks if the current activity is part of an active Bundle starting from its BOAppointment.

Parameters:

tooltipData - the tool-tip data

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadBundleAggregate

protected BundleEntitiesAggregate loadBundleAggregate(Long bundleOperationId,
 PoolKit poolKit)
                                               throws DAValidateException,
DAException

Loads the corresponding BundleEntitiesAggregate starting from the given BOBundleOperation id.

Parameters:

bundleOperationId - the BOBundleOperation id

poolKit - the PoolKit

Returns:

the loaded BundleEntitiesAggregate

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadBundle

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

Loads the needed Bundle starting from the given BOBundleOperation id.

Parameters:

bundleOperationId - the bundle operation id

poolKit - the PoolKit

Returns:

the loaded Bundle

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

prepareData

protected void prepareData(ActivityTooltipData tooltipData,
 BundleEntitiesAggregate aggregate,
 PoolKit poolKit)
                    throws DAValidateException,
DAException

Prepares the data to be displayed in the tool-tip.

Parameters:

tooltipData - the tool-tip data

aggregate - the BundleEntitiesAggregate

poolKit - the PoolKit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getBundleRelatedActivities

protected String getBundleRelatedActivities(BundleEntitiesAggregate aggregate,
 PoolKit poolKit)

Returns the codes of the BOWorkOrderOperations related to the given Bundle.

Parameters:

aggregate - the BundleEntitiesAggregate

poolKit - the PoolKit

Returns:

the codes of the bundle related operations

getBundleState

protected String getBundleState(BundleEntitiesAggregate aggregate,
 PoolKit poolKit)
                         throws DAValidateException,
DAException

Returns the description of the related BOBundleStatus.

Parameters:

aggregate - the BundleEntitiesAggregate

poolKit - the PoolKit

Returns:

the BOBundleStatus description

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getBundleWorkInterval

protected String getBundleWorkInterval(BundleEntitiesAggregate aggregate)

Returns the work interval of the given Bundle.

Parameters:

aggregate - the BundleEntitiesAggregate

Returns:

the Bundle work interval