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

Class BTResourceForecastExportExcel

java.lang.Object

overit.geocall.bl.BusinessTask<ResourceForecastExportExcelEvent>

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

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

overit.geocallapp.wfm.forecastcapacity.bl.forecast.resource.task.BTResourceForecastExportExcel

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(ResourceForecastExportExcelEvent.class)
public class BTResourceForecastExportExcel
extends ValidPermissionBusinessTask<ResourceForecastExportExcelEvent>

Business task in order to export the XLSX file of a BOResourceForecastHeader object, alongside its data,
i.e., its BOForecastResource resources and, for each resource, its BOResourceForecastSkill skills and BOForecastResourceDetail details (i.e., calendars).
When the ResourceForecastExportExcelEvent 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 BOResourceForecastHeader 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	FORECAST_RESOURCES_SHEET
protected BOCache<BOForecastResource>	forecastResourceBOCache
protected BOCache<BOForecastGroupingConstraint>	groupingConstraintBOCache
protected static final String	RESOURCE_FORECAST_HEADER_SHEET
protected BOCache<BOResourceForecastHeader>	resourceForecastHeaderBOCache
protected static final String	RESOURCES_DETAILS_SHEET
protected static final String	RESOURCES_GROUPING_CONSTRAINTS_SHEET
protected static final String	RESOURCES_SKILLS_SHEET
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
BTResourceForecastExportExcel()

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	addGroupingConstraintColumns(String sheetIdentifier, DBView sheetDBView)
protected void	appendDetailsSheet(List<BOForecastResourceDetail> resourceDetails, XlsxDocument excelDocument, PoolKit pk)	Appends the Resources Details Sheet to the specified XlsxDocument object.
protected void	appendGroupingConstraintsSheet(List<BOForecastResourceGroupingConstraint> resourceGroupingConstraints, XlsxDocument excelDocument, PoolKit pk)	Appends the Resources Grouping Constraints Sheet to the specified XlsxDocument object.
protected void	appendResourceForecastHeaderSheet(BOResourceForecastHeader resourceForecastHeader, XlsxDocument excelDocument)	Appends the Resource Forecast Header Sheet to the specified XlsxDocument object.
protected void	appendResourcesSheet(List<BOForecastResource> forecastResources, XlsxDocument excelDocument)	Appends the Forecast Resources Sheet to the specified XlsxDocument object.
protected void	appendSkillsSheet(List<BOResourceForecastSkill> resourceSkills, XlsxDocument excelDocument, PoolKit pk)	Appends the Resources Skills Sheet to the specified XlsxDocument object.
protected void	execute(ResourceForecastExportExcelEvent event, PoolKit pk)	Executes the exporting by creating an XLSX file associated with the BOResourceForecastHeader object.
protected List<BOForecastResourceDetail>	getAllForecastDetails(List<BOForecastResource> resources, PoolKit pk)	Retrieves the list of the details (i.e., calendars) associated with each BOForecastResource resource linked to the provided BOResourceForecastHeader input.
protected List<BOForecastResourceGroupingConstraint>	getAllForecastGroupingConstraints(List<BOForecastResource> resources, PoolKit pk)	Retrieves the list of the grouping constraints associated with each BOForecastResource resource linked to the provided BOResourceForecastHeader input.
protected List<BOForecastResource>	getAllForecastResources(Long resourceForecastHeaderId, PoolKit pk)	Retrieves a list of forecast resources associated with the BOResourceForecastHeader input.
protected List<BOResourceForecastSkill>	getAllForecastSkills(List<BOForecastResource> resources, PoolKit pk)	Retrieves the list of the skills associated with each BOForecastResource resource linked to the provided BOResourceForecastHeader input.
protected List<String>	getAllResourcesFullNames(String sheetIdentifier, DBView sheetDBView, PoolKit pk)	Retrieves the list of the full names (i.e., the list of the formatted name + " " + surname combinations) to be shown in the custom column named RESOURCE_FULL_NAME of the DBView sheetDBView.
protected List<String>	getGroupingConstraintsDescriptions(DBView sheetDBView, PoolKit pk)	Retrieves the list of FSM grouping constraints' IDs to be shown in the "FSM_GROUPING_CONSTRAINT_ID" column and populates that column in the DBView sheetDBView (i.e., Grouping Constraints Sheet).
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 BOResourceForecastHeader, BOForecastResource 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

RESOURCE_FORECAST_HEADER_SHEET

protected static final String RESOURCE_FORECAST_HEADER_SHEET

See Also:

• Constant Field Values

FORECAST_RESOURCES_SHEET

protected static final String FORECAST_RESOURCES_SHEET

See Also:

• Constant Field Values

RESOURCES_SKILLS_SHEET

protected static final String RESOURCES_SKILLS_SHEET

See Also:

• Constant Field Values

RESOURCES_DETAILS_SHEET

protected static final String RESOURCES_DETAILS_SHEET

See Also:

• Constant Field Values

RESOURCES_GROUPING_CONSTRAINTS_SHEET

protected static final String RESOURCES_GROUPING_CONSTRAINTS_SHEET

See Also:

• Constant Field Values

resourceForecastHeaderBOCache

protected BOCache<BOResourceForecastHeader> resourceForecastHeaderBOCache

forecastResourceBOCache

protected BOCache<BOForecastResource> forecastResourceBOCache

skillBOCache

protected BOCache<BOSkill> skillBOCache

groupingConstraintBOCache

protected BOCache<BOForecastGroupingConstraint> groupingConstraintBOCache

Constructor Details

BTResourceForecastExportExcel

public BTResourceForecastExportExcel()

Method Details

execute

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

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

Specified by:

execute in class ValidExecutionBusinessTask<ResourceForecastExportExcelEvent>

Parameters:

event - the ResourceForecastExportExcelEvent

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAllForecastResources

protected List<BOForecastResource> getAllForecastResources(Long resourceForecastHeaderId,
 PoolKit pk)
                                                    throws DAValidateException,
DAException

Retrieves a list of forecast resources associated with the BOResourceForecastHeader input.

Parameters:

resourceForecastHeaderId - the ID of BOResourceForecastHeader input

pk - the PoolKit

Returns:

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

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAllForecastSkills

protected List<BOResourceForecastSkill> getAllForecastSkills(List<BOForecastResource> resources,
 PoolKit pk)
                                                      throws DAValidateException,
DAException

Retrieves the list of the skills associated with each BOForecastResource resource linked to the provided BOResourceForecastHeader input.

Parameters:

resources - the list of BOForecastResource resources

pk - the PoolKit

Returns:

allSkills, the list of BOResourceForecastSkill objects

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAllForecastDetails

protected List<BOForecastResourceDetail> getAllForecastDetails(List<BOForecastResource> resources,
 PoolKit pk)
                                                        throws DAValidateException,
DAException

Retrieves the list of the details (i.e., calendars) associated with each BOForecastResource resource linked to the provided BOResourceForecastHeader input.

Parameters:

resources - the list of BOForecastResource resources

pk - the PoolKit

Returns:

allDetails, the list of BOForecastResourceDetail objects

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getAllForecastGroupingConstraints

protected List<BOForecastResourceGroupingConstraint> getAllForecastGroupingConstraints(List<BOForecastResource> resources,
 PoolKit pk)
                                                                                throws DAValidateException,
DAException

Retrieves the list of the grouping constraints associated with each BOForecastResource resource linked to the provided BOResourceForecastHeader input.

Parameters:

resources - the list of BOForecastResource resources

pk - the PoolKit

Returns:

allGroupingConstraints, the list of BOForecastGroupingConstraint objects

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendResourceForecastHeaderSheet

protected void appendResourceForecastHeaderSheet(BOResourceForecastHeader resourceForecastHeader,
 XlsxDocument excelDocument)
                                          throws DAException,
DAValidateException

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

Parameters:

resourceForecastHeader - the BOResourceForecastHeader input

excelDocument - the XlsxDocument object

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendResourcesSheet

protected void appendResourcesSheet(List<BOForecastResource> forecastResources,
 XlsxDocument excelDocument)
                             throws DAException,
DAValidateException

Appends the Forecast Resources Sheet to the specified XlsxDocument object.

Parameters:

forecastResources - the list containing the BOForecastResource resources linked to the provided BOResourceForecastHeader input

excelDocument - the XlsxDocument object

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendSkillsSheet

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

Appends the Resources Skills Sheet to the specified XlsxDocument object.

Parameters:

resourceSkills - the list containing the BOResourceForecastSkill skills associated with each BOForecastResource resource

excelDocument - the XlsxDocument object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendDetailsSheet

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

Appends the Resources Details Sheet to the specified XlsxDocument object.

Parameters:

resourceDetails - the list containing the BOForecastResourceDetail details (i.e., calendars) associated with each BOForecastResource resource

excelDocument - the XlsxDocument object

pk - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

appendGroupingConstraintsSheet

protected void appendGroupingConstraintsSheet(List<BOForecastResourceGroupingConstraint> resourceGroupingConstraints,
 XlsxDocument excelDocument,
 PoolKit pk)
                                       throws DAException,
DAValidateException

Appends the Resources Grouping Constraints Sheet to the specified XlsxDocument object.

Parameters:

resourceGroupingConstraints - the list containing the BOForecastGroupingConstraint grouping constraints associated with each BOForecastResource resource

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

addGroupingConstraintColumns

protected void addGroupingConstraintColumns(String sheetIdentifier,
 DBView sheetDBView)

getAllResourcesFullNames

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

Retrieves the list of the full names (i.e., the list of the formatted name + " " + surname combinations) to be shown in the custom column named RESOURCE_FULL_NAME of the DBView sheetDBView.

Parameters:

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

sheetDBView - the DBView sheet

pk - the PoolKit

Returns:

resourcesNames, the list of BOForecastResource objects' full names

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

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

getGroupingConstraintsDescriptions

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

Retrieves the list of FSM grouping constraints' IDs to be shown in the "FSM_GROUPING_CONSTRAINT_ID" column and populates that column in the DBView sheetDBView (i.e., Grouping Constraints Sheet). Then, it retrieves the list of FSM grouping constraint' descriptions to be shown in the "FSM_GROUPING_CONSTRAINT_DESCRIPTION" column.

Parameters:

sheetDBView - the DBView

pk - the PoolKit

Returns:

groupingConstraintDescriptions the list of the FSM grouping constraints' 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 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