| org.kuali.kfs.rules.AccountingDocumentRuleBase
 org.kuali.module.financial.rules.BudgetAdjustmentDocumentRule
All known Subclasses: org.kuali.module.financial.rules.YearEndBudgetAdjustmentDocumentRule,
| Method Summary | |
| public Map | buildIncomeStreamBalanceMap(BudgetAdjustmentDocument baDocument)
Builds a map used for balancing current adjustment amounts. | | protected String | getTransferDocumentType()
| | protected boolean | isAccountingLineTotalsUnchanged(AccountingDocument financialDocument)
| | public boolean | isAmountValid(AccountingDocument document, AccountingLine accountingLine)
Override needed to check the current, base, and monthly amounts. | | public boolean | isDebit(AccountingDocument financialDocument, AccountingLine accountingLine)
| | protected boolean | isDocumentBalanceValid(AccountingDocument financialDocument)
| | protected boolean | isSourceAccountingLinesRequiredNumberForRoutingMet(AccountingDocument financialDocument)
BA document does not have to have source accounting lines. | | protected boolean | isTargetAccountingLinesRequiredNumberForRoutingMet(AccountingDocument FinancialDocument)
BA document does not have to have source accounting lines. | | protected boolean | processCustomAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)
Validates when an accounting line is added to a budget adjustment document. | | protected boolean | processCustomRouteDocumentBusinessRules(Document document)
| | public boolean | processGenerateDocumentGeneralLedgerPendingEntries(AccountingDocument financialDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)
Generates any necessary tof entries to transfer funds needed to make the budget adjustments. | | public boolean | processGenerateGeneralLedgerPendingEntries(AccountingDocument financialDocument, AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)
The budget adjustment document creates GL pending entries much differently that common tp-edocs. | | public boolean | validateAccountNumber(AccountingDocument financialDocument, AccountingLine accountingLine)
Checks account number restrictions, including restrictions in parameters table. | | public boolean | validateFundGroupAdjustmentRestrictions(AccountingDocument financialDocument)
Retrieves the fund group and sub fund group for each accounting line. | | public boolean | validateMonthlyLines(AccountingDocument financialDocument, AccountingLine accountingLine)
Validates the total of the monthly amount fields (if not 0) equals the current budget amount. |
| buildIncomeStreamBalanceMap | | public Map buildIncomeStreamBalanceMap(BudgetAdjustmentDocument baDocument)(Code) | | Builds a map used for balancing current adjustment amounts. The map contains income chart and accounts contained on the
document as the keys, and transfer amounts as the values. The transfer amount is calculated from (curr_frm_inc -
curr_frm_exp) - (curr_to_inc - curr_to_exp)
Parameters:
baDocument - budget ajdustment document Map used to balance current amounts |
| getTransferDocumentType | | protected String getTransferDocumentType()(Code) | | Returns the document type code for the Transfer of Funds document
the document type name to be used for the income stream transfer glpe |
| isAccountingLineTotalsUnchanged | | protected boolean isAccountingLineTotalsUnchanged(AccountingDocument financialDocument)(Code) | | Returns true if account line totals remains unchanged from what was entered and what was persisted before
Parameters:
financialDocument - submitted accounting document true if account line totals remains unchanged fromw what was entered and what was persisted before
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.isAccountingLineTotalsUnchanged(org.kuali.core.document.FinancialDocument) |
| isAmountValid | | public boolean isAmountValid(AccountingDocument document, AccountingLine accountingLine)(Code) | | Override needed to check the current, base, and monthly amounts.
Parameters:
document - submitted accounting document
Parameters:
accountingLine - accounting line where current, base, and monthly amounts are being validated.
See Also: org.kuali.core.rule.AccountingLineRule.isAmountValid(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLine) |
| isDebit | | public boolean isDebit(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | Returns true if accounting line is debit
Parameters:
financialDocument - submitted financial document
Parameters:
accountingLine - accouting line being evaulated as a debit or not
See Also: org.kuali.core.rule.AccountingLineRule.isDebit(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLine) |
| isDocumentBalanceValid | | protected boolean isDocumentBalanceValid(AccountingDocument financialDocument)(Code) | | In order for the BA document to balance: Total of Base Income Adjustments - Base Expense Adjustments on decrease side must
equal Total of Base Income Adjustments - Base Expense Adjustments on increase side Total of Current Income Adjustments - Base
Current Adjustments on decrease side must equal Total of Current Income Adjustments - Base Current Adjustments on increase
side
Parameters:
sumbmitted - financial document true if base amounts are equal and current amounts balance and income stream balance should equal 0
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.isDocumentBalanceValid(org.kuali.core.document.FinancialDocument) |
| isSourceAccountingLinesRequiredNumberForRoutingMet | | protected boolean isSourceAccountingLinesRequiredNumberForRoutingMet(AccountingDocument financialDocument)(Code) | | BA document does not have to have source accounting lines. In the case of setting up a budget for a new account, only targets
line (increase section) are setup.
Parameters:
financialDocument - submitted financial document true if both source and target lines are NOT empty
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.isSourceAccountingLinesRequiredNumberForRoutingMet(org.kuali.core.document.FinancialDocument) |
| isTargetAccountingLinesRequiredNumberForRoutingMet | | protected boolean isTargetAccountingLinesRequiredNumberForRoutingMet(AccountingDocument FinancialDocument)(Code) | | BA document does not have to have source accounting lines. In the case of closing out an account, only source lines (decrease
section) are setup.
Parameters:
financialDocument - submitted financial document true
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.isTargetAccountingLinesRequiredNumberForRoutingMet(org.kuali.core.document.FinancialDocument) |
| processCustomAddAccountingLineBusinessRules | | protected boolean processCustomAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | Validates when an accounting line is added to a budget adjustment document. Accounting line's budget adjustment amount must
be non zero and a budget adjustment must be allowed. In addition, the monthly amount fields must equal the current budget
amount and the accounting line's account must have a budget recording level and if current adjustment amount is non zero,
account must have an associated income stream chart and account.
Parameters:
financialDocument - submitted document
Parameters:
accountingLine - validated accouting line true if validation criteria listed above is true
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.processCustomAddAccountingLineBusinessRules(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLine) |
| processCustomRouteDocumentBusinessRules | | protected boolean processCustomRouteDocumentBusinessRules(Document document)(Code) | | Calls FinancialDocumentRuleBase.processCustomRouteDocumentBusinessRules() and also validates whether the document's
accounting lines' fund group and sub fund group codes associate with the 'Budget Adjustment Restriction Code'
Parameters:
document - submitted document true if criteria above is met
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.processCustomRouteDocumentBusinessRules(org.kuali.core.document.Document) |
| processGenerateDocumentGeneralLedgerPendingEntries | | public boolean processGenerateDocumentGeneralLedgerPendingEntries(AccountingDocument financialDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)(Code) | | Generates any necessary tof entries to transfer funds needed to make the budget adjustments. Based on income chart and
accounts. If there is a difference in funds between an income chart and account, a tof entry needs to be created, along with
a budget adjustment entry. Object code used is retrieved by a parameter.
Parameters:
financialDocument - submitted accounting document
Parameters:
sequenceHelper - helper class for keeping track of sequence number true general ledger pending entries are generated without any problems
See Also: org.kuali.core.rule.GenerateGeneralLedgerDocumentPendingEntriesRule.processGenerateDocumentGeneralLedgerPendingEntries(org.kuali.core.document.FinancialDocumentorg.kuali.core.util.GeneralLedgerPendingEntrySequenceHelper) |
| processGenerateGeneralLedgerPendingEntries | | public boolean processGenerateGeneralLedgerPendingEntries(AccountingDocument financialDocument, AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)(Code) | | The budget adjustment document creates GL pending entries much differently that common tp-edocs. The glpes are created for
BB, CB, and MB balance types. Up to 14 entries per line can be created. Along with this, the BA will create TOF entries if
needed to move funding.
Parameters:
financialDocument - submitted accounting document
Parameters:
accountingLine - validated accounting line
Parameters:
sequenceHelper - helper class for keeping track of sequence number true if GLPE entries are successfully created.
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.processGenerateGeneralLedgerPendingEntries(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLineorg.kuali.core.util.GeneralLedgerPendingEntrySequenceHelper) |
| validateAccountNumber | | public boolean validateAccountNumber(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | Checks account number restrictions, including restrictions in parameters table.
Parameters:
financialDocument - submitted accounting document
Parameters:
accountingLine - accounting line with validated account number true if account number has a budget recording level and if the current adjustment amount is non-zero, account musthave an associated income stream chart and account |
| validateFundGroupAdjustmentRestrictions | | public boolean validateFundGroupAdjustmentRestrictions(AccountingDocument financialDocument)(Code) | | Retrieves the fund group and sub fund group for each accounting line. Then verifies that the codes associated with the
'Budget Adjustment Restriction Code' field are met.
Parameters:
financialDocument - submitted accounting document true if fund group and sub fund group for each accounting line if restrictions are met |
| validateMonthlyLines | | public boolean validateMonthlyLines(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | Validates the total of the monthly amount fields (if not 0) equals the current budget amount. If current budget is 0, then
total of monthly fields must be 0.
Parameters:
financialDocument - submitted accounting document
Parameters:
accountingLine - validated accounting line true if monthly amount fields equals the current budget amount |
| Fields inherited from org.kuali.kfs.rules.AccountingDocumentRuleBase | protected static org.apache.log4j.Logger LOG(Code)(Java Doc)
|
| Methods inherited from org.kuali.kfs.rules.AccountingDocumentRuleBase | protected boolean accountIsAccessible(AccountingDocument financialDocument, AccountingLine accountingLine)(Code)(Java Doc)
protected void buildTotalChangeErrorMessage(String propertyName, KualiDecimal persistedSourceLineTotal, KualiDecimal currentSourceLineTotal)(Code)(Java Doc)
protected boolean checkAccountingLineAccountAccessibility(AccountingDocument financialDocument, AccountingLine accountingLine, AccountingLineAction action)(Code)(Java Doc)
protected void customizeExplicitGeneralLedgerPendingEntry(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry)(Code)(Java Doc)
protected boolean customizeOffsetGeneralLedgerPendingEntry(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry)(Code)(Java Doc)
protected Class getAccountingLineDocumentClass(AccountingDocument financialDocument)(Code)(Java Doc)
protected KualiDecimal getGeneralLedgerPendingEntryAmountForAccountingLine(AccountingLine accountingLine)(Code)(Java Doc)
protected ParameterService getParameterService()(Code)(Java Doc)
final protected void handleNonExistentDocumentWhenApproving(AccountingDocument accountingDocument)(Code)(Java Doc)
protected boolean hasAccessibleAccountingLines(AccountingDocument financialDocument, int min)(Code)(Java Doc)
protected boolean isAccountingLineTotalsUnchanged(AccountingDocument accountingDocument)(Code)(Java Doc)
protected boolean isAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)(Code)(Java Doc)
public boolean isAmountValid(AccountingDocument document, AccountingLine accountingLine)(Code)(Java Doc)
final public boolean isAsset(AccountingLine accountingLine)(Code)(Java Doc)
final public boolean isAssetTypeCode(String objectTypeCode)(Code)(Java Doc)
final public boolean isBudgetOnlyCodesSubType(String objectCode)(Code)(Java Doc)
final public boolean isCashSubType(String objectCode)(Code)(Java Doc)
final public boolean isCostRecoveryExpenseSubType(String objectCode)(Code)(Java Doc)
public boolean isCredit(AccountingLine accountingLine, AccountingDocument financialDocument) throws IllegalStateException(Code)(Java Doc)
protected boolean isDocumentBalanceValid(AccountingDocument accountingDocument)(Code)(Java Doc)
protected boolean isDocumentBalanceValidConsideringDebitsAndCredits(AccountingDocument accountingDocument)(Code)(Java Doc)
protected boolean isErrorCorrection(AccountingDocument accountingDocument)(Code)(Java Doc)
public boolean isExpense(AccountingLine accountingLine)(Code)(Java Doc)
final public boolean isExpenseOrAsset(AccountingLine line)(Code)(Java Doc)
final public boolean isFringeBenefitsSubType(String objectCode)(Code)(Java Doc)
final public boolean isFundBalanceCode(String objectCode)(Code)(Java Doc)
final public boolean isFundBalanceSubType(String objectCode)(Code)(Java Doc)
public boolean isFundGroupAllowed(Class documentClass, AccountingLine accountingLine)(Code)(Java Doc)
protected boolean isFundGroupSetBalanceValid(AccountingDocument tranDoc, Class componentClass, String parameterName)(Code)(Java Doc)
final public boolean isHourlyWagesSubType(String objectCode)(Code)(Java Doc)
final public boolean isIncome(AccountingLine accountingLine)(Code)(Java Doc)
final public boolean isIncomeOrLiability(AccountingLine line)(Code)(Java Doc)
final public boolean isLiability(AccountingLine accountingLine)(Code)(Java Doc)
final public boolean isLiabilityTypeCode(String objectTypeCode)(Code)(Java Doc)
final public boolean isMandatoryTransfersSubType(String objectSubTypeCode)(Code)(Java Doc)
final public boolean isNonMandatoryTransfersSubType(String objectSubTypeCode)(Code)(Java Doc)
public boolean isObjectCodeAllowed(Class documentClass, AccountingLine accountingLine)(Code)(Java Doc)
public boolean isObjectConsolidationAllowed(Class documentClass, AccountingLine accountingLine)(Code)(Java Doc)
public boolean isObjectLevelAllowed(Class documentClass, AccountingLine accountingLine)(Code)(Java Doc)
public boolean isObjectSubTypeAllowed(Class documentClass, AccountingLine accountingLine)(Code)(Java Doc)
public boolean isObjectTypeAllowed(Class documentClass, AccountingLine accountingLine)(Code)(Java Doc)
protected boolean isOptionalOneSidedDocumentAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)(Code)(Java Doc)
final public boolean isRevenue(AccountingLine line)(Code)(Java Doc)
final public boolean isSalariesSubType(String objectCode)(Code)(Java Doc)
protected boolean isSourceAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)(Code)(Java Doc)
public boolean isSubFundGroupAllowed(Class documentClass, AccountingLine accountingLine)(Code)(Java Doc)
protected boolean isTargetAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)(Code)(Java Doc)
final public boolean isValuationsAndAdjustmentsSubType(String objectSubTypeCode)(Code)(Java Doc)
protected void populateExplicitGeneralLedgerPendingEntry(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, GeneralLedgerPendingEntry explicitEntry)(Code)(Java Doc)
public boolean processAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code)(Java Doc)
protected boolean processCustomAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code)(Java Doc)
protected boolean processCustomApproveDocumentBusinessRules(ApproveDocumentEvent approveEvent)(Code)(Java Doc)
protected boolean processCustomDeleteAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, boolean lineWasAlreadyDeletedFromDocument)(Code)(Java Doc)
protected boolean processCustomReviewAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code)(Java Doc)
protected boolean processCustomRouteDocumentBusinessRules(Document document)(Code)(Java Doc)
protected boolean processCustomUpdateAccountingLineBusinessRules(AccountingDocument accountingDocument, AccountingLine originalAccountingLine, AccountingLine updatedAccountingLine)(Code)(Java Doc)
public boolean processDeleteAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, boolean lineWasAlreadyDeletedFromDocument)(Code)(Java Doc)
protected boolean processExplicitGeneralLedgerPendingEntry(AccountingDocument accountingDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry)(Code)(Java Doc)
public boolean processGenerateGeneralLedgerPendingEntries(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)(Code)(Java Doc)
protected boolean processOffsetGeneralLedgerPendingEntry(AccountingDocument accountingDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry)(Code)(Java Doc)
public boolean processReviewAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code)(Java Doc)
public boolean processUpdateAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, AccountingLine updatedAccountingLine)(Code)(Java Doc)
public static void putRequiredPropertyError(BusinessObjectEntry boe, String propertyName)(Code)(Java Doc)
protected void reportError(String propertyName, String errorKey, String... errorParams)(Code)(Java Doc)
protected AccountingDocument retrievePersistedDocument(AccountingDocument accountingDocument)(Code)(Java Doc)
|
|
|