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

All Known Implementing Classes:

BenefitsCalculationServiceImpl

public interface BenefitsCalculationService

This class defines methods that a Benefits Calculation Service must provide The Benefits Calculation Service supports functionality related to calculating benefits request amounts for a Budget Construction Document (account/sub-account). This includes calculations for annual and monthly amounts. Monthly amounts are only calculated when associated monthly request amounts exist.

Method Summary

void	calculateAllBudgetConstructionGeneralLedgerBenefits(String documentNumber, Integer fiscalYear, String chartOfAccounts, String accountNumber, String subAccountNumber) calculates both the monthly budget and the annual budget budget construction general ledger benefits for the key passed in, and stores them in the database.
void	calculateAnnualBudgetConstructionGeneralLedgerBenefits(String documentNumber, Integer fiscalYear, String chartOfAccounts, String accountNumber, String subAccountNumber) calculates the annual benefits for the budget construction general ledger key passed in, and stores them in the database
void	calculateMonthlyBudgetConstructionGeneralLedgerBenefits(String documentNumber, Integer fiscalYear, String chartOfAccounts, String accountNumber, String subAccountNumber) calculates the monthly budget benefits for the budget construction general ledger key passed in, and stores them in the database
boolean	isBenefitsCalculationDisabled() This method returns the disabled setting of the System Parameter controlling Budget module Benefits Calculation.

Method Detail

isBenefitsCalculationDisabled

boolean isBenefitsCalculationDisabled()

This method returns the disabled setting of the System Parameter controlling Budget module Benefits Calculation. Disabling Benefits Calculation will cause any UI controls related to the Benefits Calculation functionality to not be displayed. Disabling will also cause associated business rules checks to behave differently or not be run.

Returns:

calculateAnnualBudgetConstructionGeneralLedgerBenefits

void calculateAnnualBudgetConstructionGeneralLedgerBenefits(String documentNumber,
                                                            Integer fiscalYear,
                                                            String chartOfAccounts,
                                                            String accountNumber,
                                                            String subAccountNumber)

calculates the annual benefits for the budget construction general ledger key passed in, and stores them in the database

Parameters:

documentNumber - the string containing the document number

fiscalYear - the integer value of the fiscal year

chartOfAccounts - the string containing the chart of accounts

accountNumber - the string containing the account number

subAccountNumber - the string containing the sub account number

calculateMonthlyBudgetConstructionGeneralLedgerBenefits

void calculateMonthlyBudgetConstructionGeneralLedgerBenefits(String documentNumber,
                                                             Integer fiscalYear,
                                                             String chartOfAccounts,
                                                             String accountNumber,
                                                             String subAccountNumber)

calculates the monthly budget benefits for the budget construction general ledger key passed in, and stores them in the database

Parameters:

documentNumber - the string containing the document number

fiscalYear - the integer value of the fiscal year

chartOfAccounts - the string containing the chart of accounts

accountNumber - the string containing the account number

subAccountNumber - the string containing the sub account number

calculateAllBudgetConstructionGeneralLedgerBenefits

void calculateAllBudgetConstructionGeneralLedgerBenefits(String documentNumber,
                                                         Integer fiscalYear,
                                                         String chartOfAccounts,
                                                         String accountNumber,
                                                         String subAccountNumber)

calculates both the monthly budget and the annual budget budget construction general ledger benefits for the key passed in, and stores them in the database.

Parameters:

documentNumber - the string containing the document number

fiscalYear - the integer value of the fiscal year

chartOfAccounts - the string containing the chart of accounts

accountNumber - the string containing the account number

subAccountNumber -