org.kuali.kfs.module.bc.document.service
Interface BudgetConstructionMonthlyBudgetsCreateDeleteService

All Known Implementing Classes:

BudgetConstructionMonthlyBudgetsCreateDeleteServiceImpl

public interface BudgetConstructionMonthlyBudgetsCreateDeleteService

distribute the request amount for a set of budget construction general ledger rows evenly among twelve monthly periods in a budget construction monthly budget row with the same key. if the amount to be spread is not divisible by 12, the adjustment will be added or subtracted from the amount in the first monthly period.

Method Summary

void	deleteBudgetConstructionMonthlyBudgetsExpenditure(String documentNumber, Integer fiscalYear, String chartCode, String accountNumber, String subAccountNumber) remove the existing expenditure monthly budgets for this key
void	deleteBudgetConstructionMonthlyBudgetsRevenue(String documentNumber, Integer fiscalYear, String chartCode, String accountNumber, String subAccountNumber) remove the existing revenue monthly budgets for this key
boolean	spreadBudgetConstructionMonthlyBudgetsExpenditure(String documentNumber, Integer fiscalYear, String chartCode, String accountNumber, String subAccountNumber) spread the expenditures for this key evenly over 12 months, with any reaminder mod 12 added to the first month
void	spreadBudgetConstructionMonthlyBudgetsRevenue(String documentNumber, Integer fiscalYear, String chartCode, String accountNumber, String subAccountNumber) spread the revenue for this key evenly over 12 months, with any remainder mod 12 added to the first month

Method Detail

deleteBudgetConstructionMonthlyBudgetsRevenue

void deleteBudgetConstructionMonthlyBudgetsRevenue(String documentNumber,
                                                   Integer fiscalYear,
                                                   String chartCode,
                                                   String accountNumber,
                                                   String subAccountNumber)
                                                   throws IOException,
                                                          NoSuchFieldException

remove the existing revenue monthly budgets for this key

Parameters:

documentNumber - the budget construction document number

fiscalYear - the fiscal year for which the budget is being built. this and the fields below are the key to a budget construction document

chartCode -

accountNumber -

subAccountNumber -

Throws:

IOException

NoSuchFieldException

deleteBudgetConstructionMonthlyBudgetsExpenditure

void deleteBudgetConstructionMonthlyBudgetsExpenditure(String documentNumber,
                                                       Integer fiscalYear,
                                                       String chartCode,
                                                       String accountNumber,
                                                       String subAccountNumber)
                                                       throws IOException,
                                                              NoSuchFieldException

remove the existing expenditure monthly budgets for this key

Parameters:

documentNumber - the budget construction document number

fiscalYear - the fiscal year for which the budget is being built. this and the fields below are the key to a budget construction document

chartCode -

accountNumber -

subAccountNumber -

Throws:

IOException

NoSuchFieldException

spreadBudgetConstructionMonthlyBudgetsRevenue

void spreadBudgetConstructionMonthlyBudgetsRevenue(String documentNumber,
                                                   Integer fiscalYear,
                                                   String chartCode,
                                                   String accountNumber,
                                                   String subAccountNumber)
                                                   throws IOException,
                                                          NoSuchFieldException

spread the revenue for this key evenly over 12 months, with any remainder mod 12 added to the first month

Parameters:

documentNumber - the budget construction document number

fiscalYear - the fiscal year for which the budget is being built. this and the fields below are the key to a budget construction document

chartCode -

accountNumber -

subAccountNumber -

Throws:

IOException

NoSuchFieldException

spreadBudgetConstructionMonthlyBudgetsExpenditure

boolean spreadBudgetConstructionMonthlyBudgetsExpenditure(String documentNumber,
                                                          Integer fiscalYear,
                                                          String chartCode,
                                                          String accountNumber,
                                                          String subAccountNumber)
                                                          throws IOException,
                                                                 NoSuchFieldException

spread the expenditures for this key evenly over 12 months, with any reaminder mod 12 added to the first month

Parameters:

documentNumber - the budget construction document number

fiscalYear - the fiscal year for which the budget is being built. this and the fields below are the key to a budget construction document

chartCode -

accountNumber -

subAccountNumber -

Returns:

FAILED if the SQL could not be built, BENEFITS if benefits need to be recalculated, NO_BENEFITS otherwise

Throws:

IOException

NoSuchFieldException