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

Class BTCapacityPlanningScenarioCoverageTimeReport

java.lang.Object

overit.geocall.bl.BusinessTask<CapacityPlanningScenarioCoverageTimeReportEvent>

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

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

overit.geocallapp.wfm.forecastcapacity.bl.capacityplanning.scenario.task.BTCapacityPlanningScenarioCoverageReport<CapacityPlanningScenarioCoverageTimeReportEvent>

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

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(CapacityPlanningScenarioCoverageTimeReportEvent.class)
public class BTCapacityPlanningScenarioCoverageTimeReport
extends BTCapacityPlanningScenarioCoverageReport<CapacityPlanningScenarioCoverageTimeReportEvent>

Business task to generate the coverage time report for a capacity planning scenario.

Since:

19.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class overit.geocallapp.wfm.forecastcapacity.bl.capacityplanning.scenario.task.BTCapacityPlanningScenarioCoverageReport

FROM, MONTH, TO

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

LOG

Constructor Summary

Constructors

Constructor	Description
BTCapacityPlanningScenarioCoverageTimeReport()

Method Summary

Modifier and Type	Method	Description
protected DateTimeRange	adjustDateRangeForWeeklyGrouping(DateTimeRange dateRange, TimeGroupingType groupingType)	Adjusts the date range for weekly grouping to ensure complete weeks.
protected void	dailyReport(List<Map<String,Object>> availableCapacity, List<Map<String,Object>> committedCapacity, List<Map<String,Object>> demand, Date day, CapacityPlanningScenarioCoverageTimeReportOutput output)	Create a report for the given day.
protected void	execute(CapacityPlanningScenarioCoverageTimeReportEvent event, PoolKit poolKit)	Calculate the coverage time for a capacity planning scenario.
protected List<CapacityPlanningScenarioCoverageTimeReportOutput>	formatCoverageTimeReport(BOCapacityPlanningScenario scenario, List<Map<String,Object>> availableCapacity, List<Map<String,Object>> committedCapacity, List<Map<String,Object>> demand, TimeGroupingType groupingType, DateTimeRange date)	Format the coverage time report.
protected List<Map<String,Object>>	loadAvailableCapacity(Long resourceForecastHeader, List<Long> resourceIds, DateTimeRange date, TimeGroupingType groupingType, PoolKit poolKit)	Load the available capacity of a resource forecast detail grouped by the specified TimeGroupingType.
protected List<Map<String,Object>>	loadCommittedCapacity(Long capacityPlanningScenarioId, List<Long> resourceIds, List<Long> activityIds, DateTimeRange date, TimeGroupingType groupingType, PoolKit poolKit)	Load the committed capacity of a capacity planning scenario grouped by the specified TimeGroupingType.
protected List<Map<String,Object>>	loadDemand(Long activityForecastHeader, List<Long> activityIds, DateTimeRange date, TimeGroupingType groupingType, LogHelper logHelper, PoolKit poolKit)	Load the demand of the resource forecast header grouped by the specified TimeGroupingType.
protected List<BOForecastResource>	loadResources(BOCapacityPlanningScenario scenario, Collection<Long> resourceIds, Collection<Long> skills, PoolKit poolKit)	Loads the resources of the given capacity planning scenario.
protected void	monthlyReport(List<Map<String,Object>> availableCapacity, List<Map<String,Object>> committedCapacity, List<Map<String,Object>> demand, Long month, Long year, CapacityPlanningScenarioCoverageTimeReportOutput output)	Create a report for the given month.
protected void	populateOutput(CapacityPlanningScenarioCoverageTimeReportOutput output, List<Map<String,Object>> availableCapacityFiltered, List<Map<String,Object>> committedCapacityFiltered, List<Map<String,Object>> demandFiltered)	Populate the output with the data from the available and committed capacity.
protected void	validate(CapacityPlanningScenarioCoverageTimeReportFilter input)	Validates the input parameters.
protected void	weeklyReport(List<Map<String,Object>> availableCapacity, List<Map<String,Object>> committedCapacity, List<Map<String,Object>> demand, Long week, Long year, CapacityPlanningScenarioCoverageTimeReportOutput output)	Create a report for the given week.

Methods inherited from class overit.geocallapp.wfm.forecastcapacity.bl.capacityplanning.scenario.task.BTCapacityPlanningScenarioCoverageReport

filterActivitiesBySkills, filterResourcesBySkills, getDistributedWorkload, getForecastActivitiesDetails, getSourceTimeframes, isValidExecution, loadActivities, loadCapacityPlanningScenario, populateAvailableCapacityOutput, populateCommittedCapacityOutput, populateDemandOutput, searchSkills, timeframeToMap

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

Constructor Details

BTCapacityPlanningScenarioCoverageTimeReport

public BTCapacityPlanningScenarioCoverageTimeReport()

Method Details

execute

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

Calculate the coverage time for a capacity planning scenario.

Specified by:

execute in class ValidExecutionBusinessTask<CapacityPlanningScenarioCoverageTimeReportEvent>

Parameters:

event - the CapacityPlanningScenarioCoverageTimeReportEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

validate

protected void validate(CapacityPlanningScenarioCoverageTimeReportFilter input)
                 throws DAValidateException

Validates the input parameters.

Throws:

DAValidateException

loadResources

protected List<BOForecastResource> loadResources(BOCapacityPlanningScenario scenario,
 Collection<Long> resourceIds,
 Collection<Long> skills,
 PoolKit poolKit)
                                          throws DAException,
DAValidateException

Loads the resources of the given capacity planning scenario.

Overrides:

loadResources in class BTCapacityPlanningScenarioCoverageReport<CapacityPlanningScenarioCoverageTimeReportEvent>

Parameters:

scenario - the BOCapacityPlanningScenario

resourceIds - the resource ids

skills - the skills

poolKit - the PoolKit

Returns:

the list of BOForecastResource

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadAvailableCapacity

protected List<Map<String,Object>> loadAvailableCapacity(Long resourceForecastHeader,
 List<Long> resourceIds,
 DateTimeRange date,
 TimeGroupingType groupingType,
 PoolKit poolKit)
                                                  throws DAException,
DAValidateException

Load the available capacity of a resource forecast detail grouped by the specified TimeGroupingType.

Parameters:

resourceForecastHeader - the resource forecast header id

resourceIds - the list of resources

date - the filter date

groupingType - the grouping type

poolKit - the PoolKit

Returns:

the list of available capacity

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadCommittedCapacity

protected List<Map<String,Object>> loadCommittedCapacity(Long capacityPlanningScenarioId,
 List<Long> resourceIds,
 List<Long> activityIds,
 DateTimeRange date,
 TimeGroupingType groupingType,
 PoolKit poolKit)
                                                  throws DAException,
DAValidateException

Load the committed capacity of a capacity planning scenario grouped by the specified TimeGroupingType.

Parameters:

capacityPlanningScenarioId - the capacity planning scenario id

resourceIds - the list of resources

activityIds - the list of activities

date - the filter date

groupingType - the grouping type

poolKit - the PoolKit

Returns:

the list of committed capacity

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

loadDemand

protected List<Map<String,Object>> loadDemand(Long activityForecastHeader,
 List<Long> activityIds,
 DateTimeRange date,
 TimeGroupingType groupingType,
 LogHelper logHelper,
 PoolKit poolKit)
                                       throws DAException,
DAValidateException

Load the demand of the resource forecast header grouped by the specified TimeGroupingType.

Parameters:

activityForecastHeader - the resource forecast header id

activityIds - the list of activity ids

date - the filter date range

groupingType - the grouping type

poolKit - the PoolKit

Returns:

the list of demand

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

formatCoverageTimeReport

protected List<CapacityPlanningScenarioCoverageTimeReportOutput> formatCoverageTimeReport(BOCapacityPlanningScenario scenario,
 List<Map<String,Object>> availableCapacity,
 List<Map<String,Object>> committedCapacity,
 List<Map<String,Object>> demand,
 TimeGroupingType groupingType,
 DateTimeRange date)

Format the coverage time report.

Parameters:

scenario - the capacity planning scenario

availableCapacity - the available capacity

committedCapacity - the committed capacity

demand - the demand

groupingType - the grouping type

date -

Returns:

the list of CapacityPlanningScenarioCoverageTimeReportOutput

dailyReport

protected void dailyReport(List<Map<String,Object>> availableCapacity,
 List<Map<String,Object>> committedCapacity,
 List<Map<String,Object>> demand,
 Date day,
 CapacityPlanningScenarioCoverageTimeReportOutput output)

Create a report for the given day.

Parameters:

availableCapacity - the list of available capacity

committedCapacity - the list of committed capacity

day - the day

output - the CapacityPlanningScenarioCoverageTimeReportOutput

weeklyReport

protected void weeklyReport(List<Map<String,Object>> availableCapacity,
 List<Map<String,Object>> committedCapacity,
 List<Map<String,Object>> demand,
 Long week,
 Long year,
 CapacityPlanningScenarioCoverageTimeReportOutput output)

Create a report for the given week.

Parameters:

availableCapacity - the list of available capacity

committedCapacity - the list of committed capacity

week - the week

year - the year

output - the CapacityPlanningScenarioCoverageTimeReportOutput

monthlyReport

protected void monthlyReport(List<Map<String,Object>> availableCapacity,
 List<Map<String,Object>> committedCapacity,
 List<Map<String,Object>> demand,
 Long month,
 Long year,
 CapacityPlanningScenarioCoverageTimeReportOutput output)

Create a report for the given month.

Parameters:

availableCapacity - the list of available capacity

committedCapacity - the list of committed capacity

month - the month

year - the year

output - the CapacityPlanningScenarioCoverageTimeReportOutput

populateOutput

protected void populateOutput(CapacityPlanningScenarioCoverageTimeReportOutput output,
 List<Map<String,Object>> availableCapacityFiltered,
 List<Map<String,Object>> committedCapacityFiltered,
 List<Map<String,Object>> demandFiltered)

Populate the output with the data from the available and committed capacity.

Parameters:

output - the CapacityPlanningScenarioCoverageTimeReportOutput

availableCapacityFiltered - the available capacity filtered by the period

committedCapacityFiltered - the committed capacity filtered by the period

adjustDateRangeForWeeklyGrouping

protected DateTimeRange adjustDateRangeForWeeklyGrouping(DateTimeRange dateRange,
 TimeGroupingType groupingType)
                                                  throws DAValidateException

Adjusts the date range for weekly grouping to ensure complete weeks. For weekly grouping, restricts the range to complete weeks: - Start date: if Monday keep it, otherwise move to next Monday - End date: if Sunday keep it, otherwise move to previous Sunday

Parameters:

dateRange - the original date range

groupingType - the grouping type

Returns:

the adjusted date range, or the original if not weekly grouping

Throws:

DAValidateException