org.kuali.kfs.module.ld.batch.service.impl
Class LaborBalanceSummaryReportServiceImpl

java.lang.Object
  org.kuali.kfs.module.ld.batch.service.impl.LaborBalanceSummaryReportServiceImpl

All Implemented Interfaces:

LaborBalanceSummaryReportService

public class LaborBalanceSummaryReportServiceImpl
extends Object
implements LaborBalanceSummaryReportService

Implements a set of methods that can generate labor balance summary reports

Constructor Summary

LaborBalanceSummaryReportServiceImpl()

Method Summary

void	generateBalanceSummaryReports() Generate the summary reports for the actual, budget and encumbrance balances
void	generateBalanceSummaryReports(Date runDate) generate a set of balance summary reports for actual, budget and encumbrance balances
protected void	generateBalanceSummaryReports(Integer fiscalYear, Date runDate)
protected void	generatePosterOutputSummaryReport(Date runDate) Generates reports about the output of a poster run.
protected List<String>	getActualBalanceTypes(Integer fiscalYear) get the actual balance type codes for the given fiscal year
protected List<String>	getBudgetBalanceTypes(Integer fiscalYear) get the budget balance type codes for the given fiscal year
protected List<String>	getEncumbranceBalanceTypes(Integer fiscalYear) get the encumbrance balance type codes for the given fiscal year
protected boolean	isInYearEndLowerBound(Date runDate, String yearEndPeriodLowerBound, String lastDayOfFiscalYear) determine if the given date is within the lower bound of year end period
protected boolean	isInYearEndPeriod(Date runDate, String yearEndPeriodLowerBound, String yearEndPeriodUpperBound, String lastDayOfFiscalYear) determine if the given date is within the year end period
protected boolean	isInYearEndUpperBound(Date runDate, String yearEndPeriodUpperBound, String lastDayOfFiscalYear) determine if the given date is within the upper bound of year end period
void	setBatchFileDirectoryName(String batchFileDirectoryName) Sets the batchFileDirectoryName attribute value.
void	setDateTimeService(org.kuali.rice.kns.service.DateTimeService dateTimeService) Sets the dateTimeService attribute value.
void	setLaborActualBalanceSummaryReportWriterService(FiscalYearAwareReportWriterService laborActualBalanceSummaryReportWriterService) Sets the laborActualBalanceSummaryReportWriterService attribute value.
void	setLaborBudgetBalanceSummaryReportWriterService(FiscalYearAwareReportWriterService laborBudgetBalanceSummaryReportWriterService) Sets the laborBudgetBalanceSummaryReportWriterService attribute value.
void	setLaborEncumbranceSummaryReportWriterService(FiscalYearAwareReportWriterService laborEncumbranceSummaryReportWriterService) Sets the laborEncumbranceSummaryReportWriterService attribute value.
void	setLaborLedgerBalanceService(LaborLedgerBalanceService laborLedgerBalanceService) Sets the laborLedgerBalanceService attribute value.
void	setLaborPosterOutputSummaryReportWriterService(ReportWriterService laborPosterOutputSummaryReportWriterService) Sets the laborPosterOutputSummaryReportWriterService attribute value.
void	setOptionsService(OptionsService optionsService) Sets the optionsService attribute value.
void	setParameterService(org.kuali.rice.kns.service.ParameterService parameterService) Sets the parameterService attribute value.
protected void	writeSummaryReport(Integer fiscalYear, List<String> balanceTypes, FiscalYearAwareReportWriterService reportWriterService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LaborBalanceSummaryReportServiceImpl

public LaborBalanceSummaryReportServiceImpl()

Method Detail

generateBalanceSummaryReports

public void generateBalanceSummaryReports()

Description copied from interface: LaborBalanceSummaryReportService

Generate the summary reports for the actual, budget and encumbrance balances

Specified by:

generateBalanceSummaryReports in interface LaborBalanceSummaryReportService

See Also:

LaborBalanceSummaryReportService.generateBalanceSummaryReports()

generateBalanceSummaryReports

public void generateBalanceSummaryReports(Date runDate)

Description copied from interface: LaborBalanceSummaryReportService

generate a set of balance summary reports for actual, budget and encumbrance balances

Specified by:

generateBalanceSummaryReports in interface LaborBalanceSummaryReportService

Parameters:

runDate - the data when the report generation starts

See Also:

LaborBalanceSummaryReportService.generateBalanceSummaryReports(java.sql.Date)

generateBalanceSummaryReports

protected void generateBalanceSummaryReports(Integer fiscalYear,
                                             Date runDate)

writeSummaryReport

protected void writeSummaryReport(Integer fiscalYear,
                                  List<String> balanceTypes,
                                  FiscalYearAwareReportWriterService reportWriterService)

generatePosterOutputSummaryReport

protected void generatePosterOutputSummaryReport(Date runDate)

Generates reports about the output of a poster run.

Parameters:

runDate - the date the poster was run.

getEncumbranceBalanceTypes

protected List<String> getEncumbranceBalanceTypes(Integer fiscalYear)

get the encumbrance balance type codes for the given fiscal year

Parameters:

fiscalYear - the given fiscal year

Returns:

the encumbrance balance type codes for the given fiscal year

getActualBalanceTypes

protected List<String> getActualBalanceTypes(Integer fiscalYear)

get the actual balance type codes for the given fiscal year

Parameters:

fiscalYear - the given fiscal year

Returns:

the actual balance type codes for the given fiscal year

getBudgetBalanceTypes

protected List<String> getBudgetBalanceTypes(Integer fiscalYear)

get the budget balance type codes for the given fiscal year

Parameters:

fiscalYear - the given fiscal year

Returns:

the budget balance type codes for the given fiscal year

isInYearEndPeriod

protected boolean isInYearEndPeriod(Date runDate,
                                    String yearEndPeriodLowerBound,
                                    String yearEndPeriodUpperBound,
                                    String lastDayOfFiscalYear)

determine if the given date is within the year end period

Parameters:

runDate - the given date

yearEndPeriodLowerBound - the lower bound date of year end period

yearEndPeriodUpperBound - the upper bound date of year end period

lastDayOfFiscalYear - the last day of the current fiscal year

Returns:

true if the given date is within the lower bound of year end period; otherwise, false

isInYearEndLowerBound

protected boolean isInYearEndLowerBound(Date runDate,
                                        String yearEndPeriodLowerBound,
                                        String lastDayOfFiscalYear)

determine if the given date is within the lower bound of year end period

Parameters:

runDate - the given date

yearEndPeriodLowerBound - the lower bound date of year end period

lastDayOfFiscalYear - the last day of the current fiscal year

Returns:

true if the given date is within the lower bound of year end period; otherwise, false

isInYearEndUpperBound

protected boolean isInYearEndUpperBound(Date runDate,
                                        String yearEndPeriodUpperBound,
                                        String lastDayOfFiscalYear)

determine if the given date is within the upper bound of year end period

Parameters:

runDate - the given date

yearEndPeriodUpperBound - the upper bound date of year end period

lastDayOfFiscalYear - the last day of the current fiscal year

Returns:

true if the given date is within the upper bound of year end period; otherwise, false

setDateTimeService

public void setDateTimeService(org.kuali.rice.kns.service.DateTimeService dateTimeService)

Sets the dateTimeService attribute value.

Parameters:

dateTimeService - The dateTimeService to set.

setOptionsService

public void setOptionsService(OptionsService optionsService)

Sets the optionsService attribute value.

Parameters:

optionsService - The optionsService to set.

setParameterService

public void setParameterService(org.kuali.rice.kns.service.ParameterService parameterService)

Sets the parameterService attribute value.

Parameters:

parameterService - The parameterService to set.

setLaborLedgerBalanceService

public void setLaborLedgerBalanceService(LaborLedgerBalanceService laborLedgerBalanceService)

Sets the laborLedgerBalanceService attribute value.

Parameters:

laborLedgerBalanceService - The laborLedgerBalanceService to set.

setLaborActualBalanceSummaryReportWriterService

public void setLaborActualBalanceSummaryReportWriterService(FiscalYearAwareReportWriterService laborActualBalanceSummaryReportWriterService)

Sets the laborActualBalanceSummaryReportWriterService attribute value.

Parameters:

laborActualBalanceSummaryReportWriterService - The laborActualBalanceSummaryReportWriterService to set.

setLaborBudgetBalanceSummaryReportWriterService

public void setLaborBudgetBalanceSummaryReportWriterService(FiscalYearAwareReportWriterService laborBudgetBalanceSummaryReportWriterService)

Sets the laborBudgetBalanceSummaryReportWriterService attribute value.

Parameters:

laborBudgetBalanceSummaryReportWriterService - The laborBudgetBalanceSummaryReportWriterService to set.

setLaborEncumbranceSummaryReportWriterService

public void setLaborEncumbranceSummaryReportWriterService(FiscalYearAwareReportWriterService laborEncumbranceSummaryReportWriterService)

Sets the laborEncumbranceSummaryReportWriterService attribute value.

Parameters:

laborEncumbranceSummaryReportWriterService - The laborEncumbranceSummaryReportWriterService to set.

setLaborPosterOutputSummaryReportWriterService

public void setLaborPosterOutputSummaryReportWriterService(ReportWriterService laborPosterOutputSummaryReportWriterService)

Sets the laborPosterOutputSummaryReportWriterService attribute value.

Parameters:

laborPosterOutputSummaryReportWriterService - The laborPosterOutputSummaryReportWriterService to set.

setBatchFileDirectoryName

public void setBatchFileDirectoryName(String batchFileDirectoryName)

Sets the batchFileDirectoryName attribute value.

Parameters:

batchFileDirectoryName - The batchFileDirectoryName to set.