Package overit.geocallapp.wfm.forecastcapacity.bl.forecast.activity.task

Class BTActivityForecastExportExcel

java.lang.Object

overit.geocall.bl.BusinessTask<ActivityForecastExportExcelEvent>

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

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

overit.geocallapp.wfm.forecastcapacity.bl.forecast.activity.task.BTActivityForecastExportExcel

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(ActivityForecastExportExcelEvent.class)
public class BTActivityForecastExportExcel
extends ValidPermissionBusinessTask<ActivityForecastExportExcelEvent>

Business task in order to export the XLSX file of a BOActivityForecastHeader object, alongside its data,
i.e., its BOForecastActivity activities and, for each activity, its BOForecastActivitySkill skills and BOForecastActivityDetail details (i.e., calendars).
When the ActivityForecastExportExcelEvent 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 BOActivityForecastHeader object.

Errors:

• Codes.EXPORT_OPERATION_FAILED: Data to export not defined

Since:

15.0

See Also:

• Serialized Form

GCApi:

task

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ACTIVITIES_DETAILS_SHEET
protected static final String	ACTIVITIES_SKILLS_SHEET
protected static final String	ACTIVITY_FORECAST_HEADER_SHEET
protected BOCache<BOActivityForecastHeader>	activityForecastHeaderBOCache
protected static final String	FORECAST_ACTIVITIES_SHEET
protected BOCache<BOForecastActivity>	forecastActivityBOCache
protected BOCache<BOForecastGroupingConstraint>	forecastGroupingConstraintBOCache
protected BOCache<BOSkill>	skillBOCache
protected static final String	XLSX_DOCUMENT
protected static final String	XLSX_DOCUMENT_EXTENSION
protected static final String	XLSX_DOCUMENT_PREFIX_NAME

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTActivityForecastExportExcel()

Method Summary

Modifier and Type	Method	Description
protected void	addCustomColumns(String sheetIdentifier, DBView sheetDBView)	Adds the custom columns (e.g., FSM_SKILL_ID, FSM_SKILL_DESCRIPTION etc.) associated to each DBView sheetDBView (e.g., Skills Sheet, Details Sheet etc.).
protected void	appendActivitiesSheet(List<BOForecastActivity> forecastActivities, XlsxDocument excelDocument)	Appends the Forecast Activities Sheet to the specified XlsxDocument object.
protected void	appendActivityForecastHeaderSheet(BOActivityForecastHeader activityForecastHeader, XlsxDocument excelDocument)	Appends the Activity Forecast Header Sheet to the specified XlsxDocument object.
protected void	appendDetailsSheet(List<BOForecastActivityDetail> activityDetails, XlsxDocument excelDocument, PoolKit pk)	Appends the Activities Details Sheet to the specified XlsxDocument object.
protected void	appendSkillsSheet(List<BOForecastActivitySkill> activitySkills, XlsxDocument excelDocument, PoolKit pk)	Appends the Activities Skills Sheet to the specified XlsxDocument object.
protected void	execute(ActivityForecastExportExcelEvent event, PoolKit pk)	Executes the exporting by creating an XLSX file associated with the BOActivityForecastHeader object.
protected List<BOForecastActivity>	getAllForecastActivities(Long activityForecastHeaderId, PoolKit pk)	Retrieves a list of forecast activities associated with the BOActivityForecastHeader input.
protected List<BOForecastActivityDetail>	getAllForecastDetails(List<BOForecastActivity> activities, PoolKit pk)	Retrieves the list of the details (i.e., calendars) associated with each BOForecastActivity activity linked to the provided BOActivityForecastHeader input.
protected List<BOForecastActivitySkill>	getAllForecastSkills(List<BOForecastActivity> activities, PoolKit pk)	Retrieves the list of the skills associated with each BOForecastActivity activity linked to the provided BOActivityForecastHeader input.
protected List<String>	getAllFormattedActivities(String sheetIdentifier, DBView sheetDBView, PoolKit pk)	Retrieves the list of the activities (i.e., the list of the formatted code + " " + description combinations) to be shown in the custom column named ACTIVITY of the DBView sheetDBView.
protected List<String>	getAllFormattedGroupingConstraints(String sheetIdentifier, DBView sheetDBView, PoolKit pk)
protected Map<Long,String>	getPrioritiesById(PoolKit pk)
protected WebResource	getReportWebResource()	Returns the report web resource.
protected List<String>	getSkillsDescriptions(DBView sheetDBView, PoolKit pk)	Retrieves the list of FSM skills' IDs to be shown in the "FSM_SKILL_ID" column and populates that column in the DBView sheetDBView (i.e., Skills Sheet).
protected void	init()	Initializes the caches for BOActivityForecastHeader, BOForecastActivity and BOSkill objects.
boolean	isValidExecution()	Determines whether the current state is valid for execution.
protected void	populateColumn(DBView sheetDBView, List<String> list, String column)	Populates the specified column of the given DBView with values from the provided list.

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

XLSX_DOCUMENT_PREFIX_NAME

protected static final String XLSX_DOCUMENT_PREFIX_NAME

See Also:

• Constant Field Values

XLSX_DOCUMENT_EXTENSION

protected static final String XLSX_DOCUMENT_EXTENSION

See Also:

• Constant Field Values

ACTIVITY_FORECAST_HEADER_SHEET

protected static final String ACTIVITY_FORECAST_HEADER_SHEET

See Also:

• Constant Field Values

FORECAST_ACTIVITIES_SHEET

protected static final String FORECAST_ACTIVITIES_SHEET

See Also:

• Constant Field Values

ACTIVITIES_SKILLS_SHEET

protected static final String ACTIVITIES_SKILLS_SHEET

See Also:

• Constant Field Values

ACTIVITIES_DETAILS_SHEET

protected static final String ACTIVITIES_DETAILS_SHEET

See Also:

• Constant Field Values

activityForecastHeaderBOCache

protected BOCache<BOActivityForecastHeader> activityForecastHeaderBOCache

forecastActivityBOCache

protected BOCache<BOForecastActivity> forecastActivityBOCache

forecastGroupingConstraintBOCache

protected BOCache<BOForecastGroupingConstraint> forecastGroupingConstraintBOCache

skillBOCache

protected BOCache<BOSkill> skillBOCache

Constructor Details

BTActivityForecastExportExcel

public BTActivityForecastExportExcel()

Method Details

execute

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

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

Specified by:

execute in class ValidExecutionBusinessTask<ActivityForecastExportExcelEvent>

Parameters:

event - the ActivityForecastExportExcelEvent

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAllForecastActivities

protected List<BOForecastActivity> getAllForecastActivities(Long activityForecastHeaderId,
 PoolKit pk)
                                                     throws DAValidateException,
DAException

Retrieves a list of forecast activities associated with the BOActivityForecastHeader input.

Parameters:

activityForecastHeaderId - the ID of BOActivityForecastHeader input

pk - the PoolKit

Returns:

searchEvent.launch(pk).getContent(); the list of BOForecastActivity objects

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAllForecastSkills

protected List<BOForecastActivitySkill> getAllForecastSkills(List<BOForecastActivity> activities,
 PoolKit pk)
                                                      throws DAValidateException,
DAException

Retrieves the list of the skills associated with each BOForecastActivity activity linked to the provided BOActivityForecastHeader input.

Parameters:

activities - the list of BOForecastActivity activities

pk - the PoolKit

Returns:

allSkills, the list of BOForecastActivitySkill objects

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAllForecastDetails

protected List<BOForecastActivityDetail> getAllForecastDetails(List<BOForecastActivity> activities,
 PoolKit pk)
                                                        throws DAValidateException,
DAException

Retrieves the list of the details (i.e., calendars) associated with each BOForecastActivity activity linked to the provided BOActivityForecastHeader input.

Parameters:

activities - the list of BOForecastActivity activities

pk - the PoolKit

Returns:

allDetails, the list of BOForecastActivityDetail objects

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendActivityForecastHeaderSheet

protected void appendActivityForecastHeaderSheet(BOActivityForecastHeader activityForecastHeader,
 XlsxDocument excelDocument)
                                          throws DAException,
DAValidateException

Appends the Activity Forecast Header Sheet to the specified XlsxDocument object.

Parameters:

activityForecastHeader - the BOActivityForecastHeader input

excelDocument - the XlsxDocument object

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendActivitiesSheet

protected void appendActivitiesSheet(List<BOForecastActivity> forecastActivities,
 XlsxDocument excelDocument)
                              throws DAException,
DAValidateException

Appends the Forecast Activities Sheet to the specified XlsxDocument object.

Parameters:

forecastActivities - the list containing the BOForecastActivity activities linked to the provided BOActivityForecastHeader input

excelDocument - the XlsxDocument object

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendSkillsSheet

protected void appendSkillsSheet(List<BOForecastActivitySkill> activitySkills,
 XlsxDocument excelDocument,
 PoolKit pk)
                          throws DAException,
DAValidateException

Appends the Activities Skills Sheet to the specified XlsxDocument object.

Parameters:

activitySkills - the list containing the BOForecastActivitySkill skills associated with each BOForecastActivity activity

excelDocument - the XlsxDocument object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendDetailsSheet

protected void appendDetailsSheet(List<BOForecastActivityDetail> activityDetails,
 XlsxDocument excelDocument,
 PoolKit pk)
                           throws DAException,
DAValidateException

Appends the Activities Details Sheet to the specified XlsxDocument object.

Parameters:

activityDetails - the list containing the BOForecastActivityDetail details (i.e., calendars) associated with each BOForecastActivity activity

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., FSM_SKILL_ID, FSM_SKILL_DESCRIPTION etc.) associated to each DBView sheetDBView (e.g., Skills Sheet, Details Sheet etc.).

Parameters:

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

sheetDBView - the DBView sheet

getAllFormattedActivities

protected List<String> getAllFormattedActivities(String sheetIdentifier,
 DBView sheetDBView,
 PoolKit pk)
                                          throws DAValidateException,
DAException

Retrieves the list of the activities (i.e., the list of the formatted code + " " + description combinations) to be shown in the custom column named ACTIVITY of the DBView sheetDBView.

Parameters:

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

sheetDBView - the DBView sheet

pk - the PoolKit

Returns:

formattedActivities, the list of BOForecastActivity's "formatted code + description" objects

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAllFormattedGroupingConstraints

protected List<String> getAllFormattedGroupingConstraints(String sheetIdentifier,
 DBView sheetDBView,
 PoolKit pk)
                                                   throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

getPrioritiesById

protected Map<Long,String> getPrioritiesById(PoolKit pk)
                                      throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

getSkillsDescriptions

protected List<String> getSkillsDescriptions(DBView sheetDBView,
 PoolKit pk)
                                      throws DAValidateException,
DAException

Retrieves the list of FSM skills' IDs to be shown in the "FSM_SKILL_ID" column and populates that column in the DBView sheetDBView (i.e., Skills Sheet). Then, it retrieves the list of FSM skills' descriptions to be shown in the "FSM_SKILL_DESCRIPTION" column.

Parameters:

sheetDBView - the DBView

pk - the PoolKit

Returns:

skillsDescriptions the list of the FSM skills' descriptions

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

populateColumn

protected void populateColumn(DBView sheetDBView,
 List<String> list,
 String column)

Populates the specified column of the given DBView with values from the provided list. This method is used to populate a column in a database view with values from a list. It iterates through each row of the database view and assigns the corresponding value from the list to the specified column.

Parameters:

sheetDBView - the DBView to be populated

list - the list of values to populate the column with

column - the name of the column to be populated

getReportWebResource

protected WebResource getReportWebResource()

Returns the report web resource.

Returns:

the report web resource

init

protected void init()

Initializes the caches for BOActivityForecastHeader, BOForecastActivity 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