Package overit.geocallapp.wfm.forecastcapacity.bl.capacityplanning.scenario.task

Class BTCapacityPlanningScenarioExportExcel

java.lang.Object

overit.geocall.bl.BusinessTask<CapacityPlanningScenarioExportExcelEvent>

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

overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask<CapacityPlanningScenarioExportExcelEvent>

overit.geocallapp.wfm.forecastcapacity.bl.capacityplanning.scenario.task.BTCapacityPlanningScenarioExportExcel

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(CapacityPlanningScenarioExportExcelEvent.class)
public class BTCapacityPlanningScenarioExportExcel
extends ValidPermissionBusinessTask<CapacityPlanningScenarioExportExcelEvent>

Business task in order to export the XLSX file of a BOCapacityPlanningScenario object, alongside its data,
i.e., its BOCapacityPlanningResult results and BOCapacityPlanningResultDetail details.

Since:

15.0

See Also:

• to get useful information about the sheets.
  When the CapacityPlanningScenarioExportExcelEvent is launched the BT notices the call and exports the XLSX file basing on the event's input, which is the id of the selected BOCapacityPlanningScenario object.
  

  Errors:

  • Codes#EXPORT_OPERATION_FAILED: Data to export not defined
• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ACTIVITY_AGGREGATE_RESULT
protected BOCache<BOActivityForecastHeader>	activityForecastHeaderCache
protected static final String	CAPACITY_PLANNING_DETAILS
protected static final String	CAPACITY_PLANNING_HEADER
protected BOCache<BOCapacityPlanningScenario>	capacityPlanningScenarioCache
protected BOCache<BOForecastActivity>	forecastActivityCache
protected BOCache<BOForecastActivityPriority>	forecastActivityPriorityCache
protected BOCache<BOForecastGroupingConstraint>	forecastGroupingConstraintCache
protected BOCache<BOForecastResource>	forecastResourceCache
protected static final String	RESOURCE_AGGREGATE_RESULT
protected BOCache<BOResourceForecastHeader>	resourceForecastHeaderCache
protected BOCache<BOSkill>	skillCache
protected static final String	XLSX_DOCUMENT

Fields inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask

LOG

Constructor Summary

Constructors

Constructor	Description
BTCapacityPlanningScenarioExportExcel()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomColumns(String sheetIdentifier, DBView sheetDBView)	Adds the custom columns (e.g., RESOURCE_FORECAST_HEADER, ACTIVITY_FORECAST_HEADER etc.) associated to each DBView sheetDBView (e.g., the sheet named "Capacity Planning Header" etc.).
protected void	appendCapacityPlanningDetailsSheet(BOCapacityPlanningScenario capacityPlanningScenario, XlsxDocument excelDocument, PoolKit pk)	Appends the "CP - Details" sheet to the specified XlsxDocument object.
protected void	appendCapacityPlanningHeaderSheet(BOCapacityPlanningScenario capacityPlanningScenario, XlsxDocument excelDocument, PoolKit pk)	Appends the "Capacity Planning Header" sheet to the specified XlsxDocument object.
protected void	appendCapacityPlanningResultSheet(BOCapacityPlanningScenario capacityPlanningScenario, XlsxDocument excelDocument, PoolKit pk)	Appends the "CP - Result" sheet to the specified XlsxDocument object.
protected void	execute(CapacityPlanningScenarioExportExcelEvent event, PoolKit pk)	Executes the exporting by creating an XLSX file associated with the BOCapacityPlanningScenario object.
protected Map<Long,BOForecastActivity>	getForecastActivitiesMap(Long activityForecastHeaderId)	Retrieves a list of BOForecastActivity objects based on the provided activityForecastHeaderId, and then converts this list into a Map object (i.e., a map).
protected Map<Long,BOForecastActivityDetail>	getForecastDetailActivitiesMap(Long activityForecastHeaderId)	Retrieves a list of BOForecastActivityDetail objects based on the provided activityForecastHeaderId, and then converts this list into a Map object (i.e., a map).
protected WebResource	getReportWebResource()	Returns the report web resource.
protected List<CapacityPlanningAllTimeframesResultDetail>	getResultsGroupedByTimeframeAndResource(List<CapacityPlanningAllTimeframesResultDetail> capacityPlanningAllTimeframesResultDetailList)	Takes a list of CapacityPlanningAllTimeframesResultDetail objects and groups them by a combination of attributes, namely Activity, ActivityTimeframe, Resource, and Team.
protected void	init()	Initializes the caches for BOResourceForecastHeader, BOForecastResource and BOSkill objects.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected void	populateActivitiesConstraintsData(Map<String,Object> row, BOForecastActivityDetail forecastActivityDetail)	Populates the column named "ACTIVITY_GROUPING_CONSTRAINT" with the grouping constraint applied to a given BOForecastActivityDetail object.
protected void	populateActivitiesData(Map<String,Object> row, BOForecastActivity forecastActivity)	Populates the columns named "ACTIVITY_CODE" and "ACTIVITY_DESCRIPTION" with the values retrieved from the given BOForecastActivity object.
protected void	populateActivitiesDetailsData(Map<String,Object> row, Long activityId, BOCapacityPlanningScenario capacityPlanningScenario, PoolKit pk)	Populates the time columns which are related to a given BOForecastActivity object.
protected void	populateActivitiesPrioritiesData(Map<String,Object> row, BOForecastActivityDetail forecastActivityDetail)	Populates the column named "ACTIVITY_PRIORITY" with the value applied to a given BOForecastActivityDetail object.
protected void	populateActivitiesSkillsData(Map<String,Object> row, Long activityId, BOCapacityPlanningScenario capacityPlanningScenario, PoolKit pk)	Populates the column named "ACTIVITY_SKILLS" with the skills applied to a given BOForecastActivity object.
protected void	populateResourcesConstraintsData(Map<String,Object> row, Long resourceId, PoolKit pk)	Populates the column named "RESOURCE_GROUPING_CONSTRAINT" with the grouping constraints applied to a given BOForecastResource object.
protected void	populateResourcesData(Map<String,Object> row, Long resourceId, BOCapacityPlanningScenario capacityPlanningScenario, PoolKit pk)	Populates the columns which are related to the BOForecastResource object (e.g., "RESOURCE_CODE", "RESOURCE_NAME", "RESOURCE_SURNAME" etc.).
protected void	populateResourcesDetailsData(Map<String,Object> row, Long activityDetailId, Long resourceId, BOCapacityPlanningScenario capacityPlanningScenario, BOForecastActivityDetail forecastActivityDetail, PoolKit pk)	Populates the column named "RESOURCE_OVERTIME" with the sum of the BOForecastResourceDetail objects' overtimes in a given timeframe.
protected void	populateResourcesSkillsData(Map<String,Object> row, Long resourceId, BOCapacityPlanningScenario capacityPlanningScenario, PoolKit pk)	Populates the column named "RESOURCE_SKILLS" with the skills applied to a given BOForecastResource object.
protected void	populateTimeframesData(Map<String,Object> row, BOForecastActivityDetail forecastActivityDetail)	Populates the columns which are related to a BOForecastActivityDetail object (i.e., a calculated timeframe).
protected BOCapacityPlanningResult	setFieldsToZero(BOCapacityPlanningResult input)	Sets the null fields of a BOCapacityPlanningResult object to 0 (i.e., a zero).

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidPermissionBusinessTask

checkValidExecution, getException, throwExceptionIfInvalid

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask

body, 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

XLSX_DOCUMENT

protected static final String XLSX_DOCUMENT

See Also:

• Constant Field Values

CAPACITY_PLANNING_HEADER

protected static final String CAPACITY_PLANNING_HEADER

See Also:

• Constant Field Values

RESOURCE_AGGREGATE_RESULT

protected static final String RESOURCE_AGGREGATE_RESULT

See Also:

• Constant Field Values

ACTIVITY_AGGREGATE_RESULT

protected static final String ACTIVITY_AGGREGATE_RESULT

See Also:

• Constant Field Values

CAPACITY_PLANNING_DETAILS

protected static final String CAPACITY_PLANNING_DETAILS

See Also:

• Constant Field Values

capacityPlanningScenarioCache

protected BOCache<BOCapacityPlanningScenario> capacityPlanningScenarioCache

resourceForecastHeaderCache

protected BOCache<BOResourceForecastHeader> resourceForecastHeaderCache

activityForecastHeaderCache

protected BOCache<BOActivityForecastHeader> activityForecastHeaderCache

forecastResourceCache

protected BOCache<BOForecastResource> forecastResourceCache

forecastActivityCache

protected BOCache<BOForecastActivity> forecastActivityCache

forecastGroupingConstraintCache

protected BOCache<BOForecastGroupingConstraint> forecastGroupingConstraintCache

skillCache

protected BOCache<BOSkill> skillCache

forecastActivityPriorityCache

protected BOCache<BOForecastActivityPriority> forecastActivityPriorityCache

Constructor Details

BTCapacityPlanningScenarioExportExcel

public BTCapacityPlanningScenarioExportExcel()

Method Details

execute

protected void execute(CapacityPlanningScenarioExportExcelEvent event,
 PoolKit pk)
                throws DAException,
DAValidateException

Executes the exporting by creating an XLSX file associated with the BOCapacityPlanningScenario object.

Specified by:

execute in class ValidExecutionBusinessTask<CapacityPlanningScenarioExportExcelEvent>

Parameters:

event - the CapacityPlanningScenarioExportExcelEvent

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendCapacityPlanningHeaderSheet

protected void appendCapacityPlanningHeaderSheet(BOCapacityPlanningScenario capacityPlanningScenario,
 XlsxDocument excelDocument,
 PoolKit pk)
                                          throws DAException,
DAValidateException

Appends the "Capacity Planning Header" sheet to the specified XlsxDocument object.

Parameters:

capacityPlanningScenario - the loaded BOCapacityPlanningScenario object

excelDocument - the XlsxDocument object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendCapacityPlanningResultSheet

protected void appendCapacityPlanningResultSheet(BOCapacityPlanningScenario capacityPlanningScenario,
 XlsxDocument excelDocument,
 PoolKit pk)
                                          throws DAValidateException,
DAException

Appends the "CP - Result" sheet to the specified XlsxDocument object. More precisely, aggregated data are appended to two XlsxTableView objects, one representing the "Resource Aggregate Results", the other the "Activity Aggregate Results".

Parameters:

capacityPlanningScenario - the loaded BOCapacityPlanningScenario object

excelDocument - the XlsxDocument object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendCapacityPlanningDetailsSheet

protected void appendCapacityPlanningDetailsSheet(BOCapacityPlanningScenario capacityPlanningScenario,
 XlsxDocument excelDocument,
 PoolKit pk)
                                           throws DAValidateException,
DAException

Appends the "CP - Details" sheet to the specified XlsxDocument object.

Parameters:

capacityPlanningScenario - the loaded BOCapacityPlanningScenario object

excelDocument - the XlsxDocument object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

addCustomColumns

protected void addCustomColumns(String sheetIdentifier,
 DBView sheetDBView)

Adds the custom columns (e.g., RESOURCE_FORECAST_HEADER, ACTIVITY_FORECAST_HEADER etc.) associated to each DBView sheetDBView (e.g., the sheet named "Capacity Planning Header" etc.).

Parameters:

sheetIdentifier - the String object used to determine the specific DBView sheet

sheetDBView - the DBView sheet

setFieldsToZero

protected BOCapacityPlanningResult setFieldsToZero(BOCapacityPlanningResult input)

Sets the null fields of a BOCapacityPlanningResult object to 0 (i.e., a zero).

Parameters:

input - the BOCapacityPlanningResult input

Returns:

input the BOCapacityPlanningResult input

getResultsGroupedByTimeframeAndResource

protected List<CapacityPlanningAllTimeframesResultDetail> getResultsGroupedByTimeframeAndResource(List<CapacityPlanningAllTimeframesResultDetail> capacityPlanningAllTimeframesResultDetailList)

Takes a list of CapacityPlanningAllTimeframesResultDetail objects and groups them by a combination of attributes, namely Activity, ActivityTimeframe, Resource, and Team. Then, it calculates the total duration and total overtime for each group and returns a list of aggregated results, namely the list of CapacityPlanningAllTimeframesResultDetail objects.

Parameters:

capacityPlanningAllTimeframesResultDetailList - , the list of CapacityPlanningAllTimeframesResultDetail objects

Returns:

the list passed as parameter, but its object are grouped by a combination of attributes

getForecastActivitiesMap

protected Map<Long,BOForecastActivity> getForecastActivitiesMap(Long activityForecastHeaderId)
                                                         throws DAException,
DAValidateException

Retrieves a list of BOForecastActivity objects based on the provided activityForecastHeaderId, and then converts this list into a Map object (i.e., a map). In the map, the keys are Long values representing the id of each BOForecastActivity object, and the values are the BOForecastActivity objects themselves.

Parameters:

activityForecastHeaderId - , the BOActivityForecastHeader's id

Returns:

the list of BOForecastActivity objects collected as a map

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getForecastDetailActivitiesMap

protected Map<Long,BOForecastActivityDetail> getForecastDetailActivitiesMap(Long activityForecastHeaderId)
                                                                     throws DAException,
DAValidateException

Retrieves a list of BOForecastActivityDetail objects based on the provided activityForecastHeaderId, and then converts this list into a Map object (i.e., a map). In the map, the keys are Long values representing the id of each BOForecastActivityDetail object, and the values are the BOForecastActivityDetail objects themselves.

Parameters:

activityForecastHeaderId - , the BOActivityForecastHeader's id

Returns:

the list of BOForecastActivityDetail objects collected as a map

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

populateResourcesData

protected void populateResourcesData(Map<String,Object> row,
 Long resourceId,
 BOCapacityPlanningScenario capacityPlanningScenario,
 PoolKit pk)
                              throws DAValidateException,
DAException

Populates the columns which are related to the BOForecastResource object (e.g., "RESOURCE_CODE", "RESOURCE_NAME", "RESOURCE_SURNAME" etc.).

Parameters:

row - the row to be updated

resourceId - the BOForecastResource's id field

capacityPlanningScenario - the loaded BOCapacityPlanningScenario object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

populateResourcesDetailsData

protected void populateResourcesDetailsData(Map<String,Object> row,
 Long activityDetailId,
 Long resourceId,
 BOCapacityPlanningScenario capacityPlanningScenario,
 BOForecastActivityDetail forecastActivityDetail,
 PoolKit pk)
                                     throws DAValidateException,
DAException

Populates the column named "RESOURCE_OVERTIME" with the sum of the BOForecastResourceDetail objects' overtimes in a given timeframe.

Parameters:

row - the row to be updated

activityDetailId - the BOForecastActivityDetail's id field

resourceId - the BOForecastResource's id field

capacityPlanningScenario - the loaded BOCapacityPlanningScenario object

forecastActivityDetail - the BOForecastActivityDetail object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

populateResourcesConstraintsData

protected void populateResourcesConstraintsData(Map<String,Object> row,
 Long resourceId,
 PoolKit pk)
                                         throws DAValidateException,
DAException

Populates the column named "RESOURCE_GROUPING_CONSTRAINT" with the grouping constraints applied to a given BOForecastResource object.

Parameters:

row - the row to be updated

resourceId - the BOForecastResource's id field

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

populateResourcesSkillsData

protected void populateResourcesSkillsData(Map<String,Object> row,
 Long resourceId,
 BOCapacityPlanningScenario capacityPlanningScenario,
 PoolKit pk)
                                    throws DAValidateException,
DAException

Populates the column named "RESOURCE_SKILLS" with the skills applied to a given BOForecastResource object.

Parameters:

row - the row to be updated

resourceId - the BOForecastResource's id field

capacityPlanningScenario - the loaded BOCapacityPlanningScenario object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

populateActivitiesData

protected void populateActivitiesData(Map<String,Object> row,
 BOForecastActivity forecastActivity)

Populates the columns named "ACTIVITY_CODE" and "ACTIVITY_DESCRIPTION" with the values retrieved from the given BOForecastActivity object.

Parameters:

row - the row to be updated

forecastActivity - the BOForecastActivity object

populateActivitiesSkillsData

protected void populateActivitiesSkillsData(Map<String,Object> row,
 Long activityId,
 BOCapacityPlanningScenario capacityPlanningScenario,
 PoolKit pk)
                                     throws DAValidateException,
DAException

Populates the column named "ACTIVITY_SKILLS" with the skills applied to a given BOForecastActivity object.

Parameters:

row - the row to be updated

activityId - the BOForecastActivity's id field

capacityPlanningScenario - the loaded BOCapacityPlanningScenario object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

populateTimeframesData

protected void populateTimeframesData(Map<String,Object> row,
 BOForecastActivityDetail forecastActivityDetail)

Populates the columns which are related to a BOForecastActivityDetail object (i.e., a calculated timeframe).

Parameters:

row - the row to be updated

forecastActivityDetail - the BOForecastActivityDetail object

populateActivitiesPrioritiesData

protected void populateActivitiesPrioritiesData(Map<String,Object> row,
 BOForecastActivityDetail forecastActivityDetail)

Populates the column named "ACTIVITY_PRIORITY" with the value applied to a given BOForecastActivityDetail object.

Parameters:

row - the row to be updated

forecastActivityDetail - the BOForecastActivityDetail object

populateActivitiesDetailsData

protected void populateActivitiesDetailsData(Map<String,Object> row,
 Long activityId,
 BOCapacityPlanningScenario capacityPlanningScenario,
 PoolKit pk)
                                      throws DAValidateException,
DAException

Populates the time columns which are related to a given BOForecastActivity object.

Parameters:

row - the row to be updated

activityId - the BOForecastActivity's id field

capacityPlanningScenario - the loaded BOCapacityPlanningScenario object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

populateActivitiesConstraintsData

protected void populateActivitiesConstraintsData(Map<String,Object> row,
 BOForecastActivityDetail forecastActivityDetail)

Populates the column named "ACTIVITY_GROUPING_CONSTRAINT" with the grouping constraint applied to a given BOForecastActivityDetail object.

Parameters:

row - the row to be updated

forecastActivityDetail - the BOForecastActivityDetail object

getReportWebResource

protected WebResource getReportWebResource()

Returns the report web resource.

Returns:

the report web resource

init

protected void init()

Initializes the caches for BOResourceForecastHeader, BOForecastResource and BOSkill objects. This method sets up the BOCache instances for efficient data loading.

isValidExecution

public boolean isValidExecution()

Description copied from interface: ValidExecution

Determines whether the current state is valid for execution.

Returns:

true if execution is valid, false otherwise