| org.kuali.kfs.rules.GeneralLedgerPostingDocumentRuleBase
 org.kuali.module.purap.rules.PurapAccountingDocumentRuleBase
All known Subclasses: org.kuali.module.purap.rules.PurchasingAccountsPayableDocumentRuleBase,
| Inner Class :public enum AccountingLineAction | |
| Inner Class :public static class IsDebitUtils | |
| Field Summary | |
| protected static org.apache.log4j.Logger | LOG
|
| Method Summary | |
| protected boolean | accountIsAccessible(AccountingDocument financialDocument, AccountingLine accountingLine)
| | protected void | buildTotalChangeErrorMessage(String propertyName, KualiDecimal persistedSourceLineTotal, KualiDecimal currentSourceLineTotal)
This method builds out the error message for when totals have changed. | | protected boolean | checkAccountingLineAccountAccessibility(AccountingDocument financialDocument, AccountingLine accountingLine, AccountingLineAction action)
If the given accountingLine has an account which is inaccessible to the current user, an error message will be put into the
global ErrorMap and into the logfile. | | protected void | customizeExplicitGeneralLedgerPendingEntry(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry)
This method can be overridden to set attributes on the explicit entry in a way specific to a particular document. | | protected boolean | customizeOffsetGeneralLedgerPendingEntry(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry)
This method can be overridden to set attributes on the offset entry in a way specific to a particular document. | | protected Class | getAccountingLineDocumentClass(AccountingDocument financialDocument)
| | protected KualiDecimal | getGeneralLedgerPendingEntryAmountForAccountingLine(AccountingLine accountingLine)
GLPE amounts are ALWAYS positive, so just take the absolute value of the accounting line's amount. | | protected ParameterService | getParameterService()
| | final protected void | handleNonExistentDocumentWhenApproving(AccountingDocument accountingDocument)
Handles the case when a non existent document is attempted to be retrieve and that if it's in an initiated state, it's ok. | | protected boolean | hasAccessibleAccountingLines(AccountingDocument financialDocument, int min)
| | protected boolean | isAccountingLineTotalsUnchanged(AccountingDocument accountingDocument)
Checks accounting line totals for approval to make sure that they have not changed. | | protected boolean | isAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)
Checks accounting line number limits for routing. | | public boolean | isAmountValid(AccountingDocument document, AccountingLine accountingLine)
This method checks the amount of a given accounting line to make sure it's not 0, it's positive for regular documents, and
negative for correction documents. | | final public boolean | isAsset(AccountingLine accountingLine)
Determines whether an accounting line is an asset line. | | final public boolean | isAssetTypeCode(String objectTypeCode)
Determines whether the objectTypeCode is an asset. | | final public boolean | isBudgetOnlyCodesSubType(String objectCode)
This method... | | final public boolean | isCashSubType(String objectCode)
This method... | | final public boolean | isCostRecoveryExpenseSubType(String objectCode)
| | public boolean | isCredit(AccountingLine accountingLine, AccountingDocument financialDocument)
Determines whether an accounting line represents a credit line. | | protected boolean | isDocumentBalanceValid(AccountingDocument accountingDocument)
This is the default implementation for Transactional Documents, which sums the amounts of all of the Debit GLPEs, and
compares it to the sum of all of the Credit GLPEs. | | protected boolean | isDocumentBalanceValidConsideringDebitsAndCredits(AccountingDocument accountingDocument)
This method sums all of the debit GLPEs up and sums all of the credit GLPEs up and then compares the totals to each other,
returning true if they are equal and false if they are not. | | protected boolean | isErrorCorrection(AccountingDocument accountingDocument)
Convience method for determine if a document is an error correction document. | | public boolean | isExpense(AccountingLine accountingLine)
Check object code type to determine whether the accounting line is expense. | | final public boolean | isExpenseOrAsset(AccountingLine line)
Determines whether an accounting line is an expense or asset. | | final public boolean | isFringeBenefitsSubType(String objectCode)
| | final public boolean | isFundBalanceCode(String objectCode)
This method... | | final public boolean | isFundBalanceSubType(String objectCode)
This method... | | public boolean | isFundGroupAllowed(Class documentClass, AccountingLine accountingLine)
This method checks to see if the fund group code for the accouting line's account is allowed. | | protected boolean | isFundGroupSetBalanceValid(AccountingDocument tranDoc, Class componentClass, String parameterName)
This method will make sure that totals for a specified set of fund groups is valid across the two different accounting line
sections.
Parameters:
tranDoc -
Parameters:
fundGroupCodes - An array of the fund group codes that will be considered for balancing. | | final public boolean | isHourlyWagesSubType(String objectCode)
This method... | | final public boolean | isIncome(AccountingLine accountingLine)
Determines whether an accounting line is an income line or not. | | final public boolean | isIncomeOrLiability(AccountingLine line)
Determines whether an accounting line is an income or liability line. | | final public boolean | isLiability(AccountingLine accountingLine)
Determines whether an accounting line is a liability line. | | final public boolean | isLiabilityTypeCode(String objectTypeCode)
Determines whether the objectTypeCode is a liability. | | final public boolean | isMandatoryTransfersSubType(String objectSubTypeCode)
This method determines whether an object sub-type code is a mandatory transfer or not. | | final public boolean | isNonMandatoryTransfersSubType(String objectSubTypeCode)
This method determines whether an object sub-type code is a non-mandatory transfer or not. | | public boolean | isObjectCodeAllowed(Class documentClass, AccountingLine accountingLine)
This method checks to see if the object code for the passed in accounting line exists in the list of restricted object codes. | | public boolean | isObjectConsolidationAllowed(Class documentClass, AccountingLine accountingLine)
This method checks to see if the object consolidation for the accouting line's object code is allowed. | | public boolean | isObjectLevelAllowed(Class documentClass, AccountingLine accountingLine)
This method checks to see if the object level for the accounting line's object code is allowed. | | public boolean | isObjectSubTypeAllowed(Class documentClass, AccountingLine accountingLine)
This method checks to see if the object sub-type code for the accounting line's object code is allowed. | | public boolean | isObjectTypeAllowed(Class documentClass, AccountingLine accountingLine)
This checks the accounting line's object type code to ensure that it is not a fund balance object type. | | protected boolean | isOptionalOneSidedDocumentAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)
Some double-sided documents also allow for one sided entries for correcting - so if one side is empty, the other side must
have at least two lines in it. | | final public boolean | isRevenue(AccountingLine line)
Check object code type to determine whether the accounting line is revenue. | | final public boolean | isSalariesSubType(String objectCode)
This method... | | protected boolean | isSourceAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)
This method will check to make sure that the required number of source accounting lines for routing, exist in the document. | | public boolean | isSubFundGroupAllowed(Class documentClass, AccountingLine accountingLine)
This method checks to see if the sub fund group code for the accounting line's account is allowed. | | protected boolean | isTargetAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)
This method will check to make sure that the required number of target accounting lines for routing, exist in the document. | | final public boolean | isValuationsAndAdjustmentsSubType(String objectSubTypeCode)
This method... | | protected void | populateExplicitGeneralLedgerPendingEntry(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, GeneralLedgerPendingEntry explicitEntry)
This populates an empty GeneralLedgerPendingEntry explicitEntry object instance with default values. | | public boolean | processAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)
This method performs common validation for adding of accounting lines. | | protected boolean | processCustomAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)
This method should be overridden in the children classes to implement business rules that don't fit into any of the other
AddAccountingLineRule interface methods. | | protected boolean | processCustomApproveDocumentBusinessRules(ApproveDocumentEvent approveEvent)
This method performs common validation for Transactional Document approvals. | | protected boolean | processCustomDeleteAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, boolean lineWasAlreadyDeletedFromDocument)
This method should be overridden in the children classes to implement deleteAccountingLine checks that don't fit into any of
the other DeleteAccountingLineRule interface methods. | | protected boolean | processCustomReviewAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)
This method should be overridden in the child classes to implement business rules that don't fit into any of the other
ReviewAccountingLineRule interface methods. | | protected boolean | processCustomRouteDocumentBusinessRules(Document document)
This method performs common validation for Transactional Document routes. | | protected boolean | processCustomUpdateAccountingLineBusinessRules(AccountingDocument accountingDocument, AccountingLine originalAccountingLine, AccountingLine updatedAccountingLine)
This method should be overridden in the children classes to implement updateAccountingLine checks that don't fit into any of
the other UpdateAccountingLineRule interface methods. | | public boolean | processDeleteAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, boolean lineWasAlreadyDeletedFromDocument)
This method performs common validation for deleting of accounting lines. | | protected boolean | processExplicitGeneralLedgerPendingEntry(AccountingDocument accountingDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry)
This method processes all necessary information to build an explicit general ledger entry, and then adds that to the
document. | | public boolean | processGenerateGeneralLedgerPendingEntries(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)
Perform business rules common to all transactional documents when generating general ledger pending entries. | | protected boolean | processOffsetGeneralLedgerPendingEntry(AccountingDocument accountingDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry)
This method processes an accounting line's information to build an offset entry, and then adds that to the document. | | public boolean | processReviewAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)
This method performs common validation for review of accounting lines. | | public boolean | processUpdateAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, AccountingLine updatedAccountingLine)
This method performs common validation for update of accounting lines. | | public static void | putRequiredPropertyError(BusinessObjectEntry boe, String propertyName)
Adds a global error for a missing required property. | | protected void | reportError(String propertyName, String errorKey, String... errorParams)
| | protected AccountingDocument | retrievePersistedDocument(AccountingDocument accountingDocument)
|
| LOG | | protected static org.apache.log4j.Logger LOG(Code) | | |
| accountIsAccessible | | protected boolean accountIsAccessible(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | |
Parameters:
financialDocument -
Parameters:
accountingLine - true if the given accountingLine refers to an account which allows it to be added, deleted, or updated |
| buildTotalChangeErrorMessage | | protected void buildTotalChangeErrorMessage(String propertyName, KualiDecimal persistedSourceLineTotal, KualiDecimal currentSourceLineTotal)(Code) | | This method builds out the error message for when totals have changed.
Parameters:
propertyName -
Parameters:
persistedSourceLineTotal -
Parameters:
currentSourceLineTotal - |
| checkAccountingLineAccountAccessibility | | protected boolean checkAccountingLineAccountAccessibility(AccountingDocument financialDocument, AccountingLine accountingLine, AccountingLineAction action)(Code) | | If the given accountingLine has an account which is inaccessible to the current user, an error message will be put into the
global ErrorMap and into the logfile.
Parameters:
financialDocument -
Parameters:
accountingLine -
Parameters:
action - true if the given accountingLine refers to an account which allows it to be added, deleted, or updated |
| customizeExplicitGeneralLedgerPendingEntry | | protected void customizeExplicitGeneralLedgerPendingEntry(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry)(Code) | | This method can be overridden to set attributes on the explicit entry in a way specific to a particular document. By default
the explicit entry is returned without modification.
Parameters:
accountingDocument -
Parameters:
accountingLine -
Parameters:
explicitEntry - |
| customizeOffsetGeneralLedgerPendingEntry | | protected boolean customizeOffsetGeneralLedgerPendingEntry(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry)(Code) | | This method can be overridden to set attributes on the offset entry in a way specific to a particular document. By default
the offset entry is not modified.
Parameters:
accountingDocument -
Parameters:
accountingLine -
Parameters:
explicitEntry -
Parameters:
offsetEntry - whether the offset generation is successful |
| getGeneralLedgerPendingEntryAmountForAccountingLine | | protected KualiDecimal getGeneralLedgerPendingEntryAmountForAccountingLine(AccountingLine accountingLine)(Code) | | GLPE amounts are ALWAYS positive, so just take the absolute value of the accounting line's amount.
Parameters:
accountingLine - KualiDecimal The amount that will be used to populate the GLPE. |
| handleNonExistentDocumentWhenApproving | | final protected void handleNonExistentDocumentWhenApproving(AccountingDocument accountingDocument)(Code) | | Handles the case when a non existent document is attempted to be retrieve and that if it's in an initiated state, it's ok.
Parameters:
accountingDocument - |
| hasAccessibleAccountingLines | | protected boolean hasAccessibleAccountingLines(AccountingDocument financialDocument, int min)(Code) | |
Parameters:
financialDocument -
Parameters:
min - true if the document has n (or more) accessible accountingLines |
| isAccountingLineTotalsUnchanged | | protected boolean isAccountingLineTotalsUnchanged(AccountingDocument accountingDocument)(Code) | | Checks accounting line totals for approval to make sure that they have not changed.
Parameters:
accountingDocument - boolean True if the number of accounting lines are valid for routing, false otherwise. |
| isAccountingLinesRequiredNumberForRoutingMet | | protected boolean isAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)(Code) | | Checks accounting line number limits for routing. This method is for overriding by documents with rules about the total
number of lines in both sections combined.
Parameters:
accountingDocument - boolean True if the number of accounting lines are valid for routing, false otherwise. |
| isAmountValid | | public boolean isAmountValid(AccountingDocument document, AccountingLine accountingLine)(Code) | | This method checks the amount of a given accounting line to make sure it's not 0, it's positive for regular documents, and
negative for correction documents.
Parameters:
document -
Parameters:
accountingLine - boolean True if there aren't any issues, false otherwise. |
| isAsset | | final public boolean isAsset(AccountingLine accountingLine)(Code) | | Determines whether an accounting line is an asset line.
Parameters:
accountingLine - boolean True if a line is an asset line. |
| isAssetTypeCode | | final public boolean isAssetTypeCode(String objectTypeCode)(Code) | | Determines whether the objectTypeCode is an asset.
Parameters:
objectTypeCode - Is she asset or something completely different? |
| isBudgetOnlyCodesSubType | | final public boolean isBudgetOnlyCodesSubType(String objectCode)(Code) | | This method...
Parameters:
objectCode - boolean |
| isCashSubType | | final public boolean isCashSubType(String objectCode)(Code) | | This method...
Parameters:
objectCode - boolean |
| isCostRecoveryExpenseSubType | | final public boolean isCostRecoveryExpenseSubType(String objectCode)(Code) | |
Parameters:
objectCode - boolean |
| isDocumentBalanceValid | | protected boolean isDocumentBalanceValid(AccountingDocument accountingDocument)(Code) | | This is the default implementation for Transactional Documents, which sums the amounts of all of the Debit GLPEs, and
compares it to the sum of all of the Credit GLPEs. In general, this algorithm works, but it does not work for some specific
documents such as the Journal Voucher. The method name denotes not an expected behavior, but a more general title so that
some documents that don't use this default implementation, can override just this method without having to override the
calling method.
Parameters:
accountingDocument - boolean True if the document is balanced, false otherwise. |
| isDocumentBalanceValidConsideringDebitsAndCredits | | protected boolean isDocumentBalanceValidConsideringDebitsAndCredits(AccountingDocument accountingDocument)(Code) | | This method sums all of the debit GLPEs up and sums all of the credit GLPEs up and then compares the totals to each other,
returning true if they are equal and false if they are not.
Parameters:
accountingDocument - boolean |
| isErrorCorrection | | protected boolean isErrorCorrection(AccountingDocument accountingDocument)(Code) | | Convience method for determine if a document is an error correction document.
Parameters:
accountingDocument - true if document is an error correct |
| isExpense | | public boolean isExpense(AccountingLine accountingLine)(Code) | | Check object code type to determine whether the accounting line is expense.
Parameters:
accountingLine - boolean True if the line is an expense line. |
| isExpenseOrAsset | | final public boolean isExpenseOrAsset(AccountingLine line)(Code) | | Determines whether an accounting line is an expense or asset.
Parameters:
line - boolean True if it's an expense or asset. |
| isFringeBenefitsSubType | | final public boolean isFringeBenefitsSubType(String objectCode)(Code) | |
Parameters:
objectCode - boolean |
| isFundBalanceCode | | final public boolean isFundBalanceCode(String objectCode)(Code) | | This method...
Parameters:
objectCode - boolean |
| isFundBalanceSubType | | final public boolean isFundBalanceSubType(String objectCode)(Code) | | This method...
Parameters:
objectCode - boolean |
| isFundGroupAllowed | | public boolean isFundGroupAllowed(Class documentClass, AccountingLine accountingLine)(Code) | | This method checks to see if the fund group code for the accouting line's account is allowed. The common implementation
allows any fund group code.
Parameters:
accountingLine - boolean |
| isFundGroupSetBalanceValid | | protected boolean isFundGroupSetBalanceValid(AccountingDocument tranDoc, Class componentClass, String parameterName)(Code) | | This method will make sure that totals for a specified set of fund groups is valid across the two different accounting line
sections.
Parameters:
tranDoc -
Parameters:
fundGroupCodes - An array of the fund group codes that will be considered for balancing. True if they balance; false otherwise. |
| isHourlyWagesSubType | | final public boolean isHourlyWagesSubType(String objectCode)(Code) | | This method...
Parameters:
objectCode - boolean |
| isIncome | | final public boolean isIncome(AccountingLine accountingLine)(Code) | | Determines whether an accounting line is an income line or not. This goes agains the configurable object type code list in
the ApplicationParameter mechanism. This list can be configured externally.
Parameters:
accountingLine - boolean True if the line is an income line. |
| isIncomeOrLiability | | final public boolean isIncomeOrLiability(AccountingLine line)(Code) | | Determines whether an accounting line is an income or liability line.
Parameters:
line - boolean True if the line is an income or liability line. |
| isLiability | | final public boolean isLiability(AccountingLine accountingLine)(Code) | | Determines whether an accounting line is a liability line.
Parameters:
accountingLine - boolean True if the line is a liability line. |
| isLiabilityTypeCode | | final public boolean isLiabilityTypeCode(String objectTypeCode)(Code) | | Determines whether the objectTypeCode is a liability.
Parameters:
objectTypeCode - Is she liability or something completely different? |
| isMandatoryTransfersSubType | | final public boolean isMandatoryTransfersSubType(String objectSubTypeCode)(Code) | | This method determines whether an object sub-type code is a mandatory transfer or not.
Parameters:
objectSubTypeCode - True if it is a manadatory transfer, false otherwise. |
| isNonMandatoryTransfersSubType | | final public boolean isNonMandatoryTransfersSubType(String objectSubTypeCode)(Code) | | This method determines whether an object sub-type code is a non-mandatory transfer or not.
Parameters:
objectSubTypeCode - True if it is a non-mandatory transfer, false otherwise. |
| isObjectCodeAllowed | | public boolean isObjectCodeAllowed(Class documentClass, AccountingLine accountingLine)(Code) | | This method checks to see if the object code for the passed in accounting line exists in the list of restricted object codes.
Note, the values that this checks against can be externally configured with the ApplicationParameter maintenance mechanism.
Parameters:
accountingLine - boolean True if the use of the object code is allowed. |
| isObjectConsolidationAllowed | | public boolean isObjectConsolidationAllowed(Class documentClass, AccountingLine accountingLine)(Code) | | This method checks to see if the object consolidation for the accouting line's object code is allowed. The common
implementation allows any object consolidation.
Parameters:
accountingLine - boolean True if the use of the object code's object sub type code is allowed; false otherwise. |
| isObjectLevelAllowed | | public boolean isObjectLevelAllowed(Class documentClass, AccountingLine accountingLine)(Code) | | This method checks to see if the object level for the accounting line's object code is allowed. The common implementation
allows any object level.
Parameters:
accountingLine - boolean True if the use of the object code's object sub type code is allowed; false otherwise. |
| isObjectSubTypeAllowed | | public boolean isObjectSubTypeAllowed(Class documentClass, AccountingLine accountingLine)(Code) | | This method checks to see if the object sub-type code for the accounting line's object code is allowed. The common
implementation allows any object sub-type code.
Parameters:
accountingLine - boolean True if the use of the object code's object sub type code is allowed; false otherwise. |
| isObjectTypeAllowed | | public boolean isObjectTypeAllowed(Class documentClass, AccountingLine accountingLine)(Code) | | This checks the accounting line's object type code to ensure that it is not a fund balance object type. This is a universal
business rule that all transaction processing documents should abide by.
Parameters:
accountingLine - boolean |
| isOptionalOneSidedDocumentAccountingLinesRequiredNumberForRoutingMet | | protected boolean isOptionalOneSidedDocumentAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)(Code) | | Some double-sided documents also allow for one sided entries for correcting - so if one side is empty, the other side must
have at least two lines in it. The balancing rules take care of validation of amounts.
Parameters:
accountingDocument - boolean |
| isRevenue | | final public boolean isRevenue(AccountingLine line)(Code) | | Check object code type to determine whether the accounting line is revenue.
Parameters:
line - boolean True if the line is a revenue line. |
| isSalariesSubType | | final public boolean isSalariesSubType(String objectCode)(Code) | | This method...
Parameters:
objectCode - boolean |
| isSourceAccountingLinesRequiredNumberForRoutingMet | | protected boolean isSourceAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)(Code) | | This method will check to make sure that the required number of source accounting lines for routing, exist in the document.
This method represents the default implementation, which is that at least one source accounting line must exist.
Parameters:
accountingDocument - isOk |
| isSubFundGroupAllowed | | public boolean isSubFundGroupAllowed(Class documentClass, AccountingLine accountingLine)(Code) | | This method checks to see if the sub fund group code for the accounting line's account is allowed. The common implementation
allows any sub fund group code.
Parameters:
accountingLine - boolean |
| isTargetAccountingLinesRequiredNumberForRoutingMet | | protected boolean isTargetAccountingLinesRequiredNumberForRoutingMet(AccountingDocument accountingDocument)(Code) | | This method will check to make sure that the required number of target accounting lines for routing, exist in the document.
This method represents the default implementation, which is that at least one target accounting line must exist.
Parameters:
accountingDocument - isOk |
| isValuationsAndAdjustmentsSubType | | final public boolean isValuationsAndAdjustmentsSubType(String objectSubTypeCode)(Code) | | This method...
Parameters:
objectSubTypeCode - boolean |
| processAddAccountingLineBusinessRules | | public boolean processAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | This method performs common validation for adding of accounting lines. Then calls a custom method for more specific
validation.
See Also: org.kuali.core.rule.AddAccountingLineRule.processAddAccountingLineBusinessRules(org.kuali.core.document.AccountingDocumentorg.kuali.core.bo.AccountingLine) |
| processCustomAddAccountingLineBusinessRules | | protected boolean processCustomAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | This method should be overridden in the children classes to implement business rules that don't fit into any of the other
AddAccountingLineRule interface methods.
Parameters:
financialDocument -
Parameters:
accountingLine - boolean |
| processCustomApproveDocumentBusinessRules | | protected boolean processCustomApproveDocumentBusinessRules(ApproveDocumentEvent approveEvent)(Code) | | This method performs common validation for Transactional Document approvals. Note the rule framework will handle validating
all of the accounting lines and also those checks that would normally be done on an approval, automatically for us.
Parameters:
approveEvent - boolean True if the document is valid for approval, false otherwise. |
| processCustomDeleteAccountingLineBusinessRules | | protected boolean processCustomDeleteAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, boolean lineWasAlreadyDeletedFromDocument)(Code) | | This method should be overridden in the children classes to implement deleteAccountingLine checks that don't fit into any of
the other DeleteAccountingLineRule interface methods.
Parameters:
financialDocument -
Parameters:
accountingLine -
Parameters:
lineWasAlreadyDeletedFromDocument - boolean |
| processCustomReviewAccountingLineBusinessRules | | protected boolean processCustomReviewAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | This method should be overridden in the child classes to implement business rules that don't fit into any of the other
ReviewAccountingLineRule interface methods.
Parameters:
financialDocument -
Parameters:
accountingLine - boolean |
| processCustomRouteDocumentBusinessRules | | protected boolean processCustomRouteDocumentBusinessRules(Document document)(Code) | | This method performs common validation for Transactional Document routes. Note the rule framework will handle validating all
of the accounting lines and also those checks that would normally be done on a save, automatically for us.
Parameters:
document - boolean True if the document is valid for routing, false otherwise. |
| processCustomUpdateAccountingLineBusinessRules | | protected boolean processCustomUpdateAccountingLineBusinessRules(AccountingDocument accountingDocument, AccountingLine originalAccountingLine, AccountingLine updatedAccountingLine)(Code) | | This method should be overridden in the children classes to implement updateAccountingLine checks that don't fit into any of
the other UpdateAccountingLineRule interface methods.
Parameters:
accountingDocument -
Parameters:
originalAccountingLine -
Parameters:
updatedAccountingLine - boolean |
| processDeleteAccountingLineBusinessRules | | public boolean processDeleteAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, boolean lineWasAlreadyDeletedFromDocument)(Code) | | This method performs common validation for deleting of accounting lines. Then calls a custom method for more specific
validation.
See Also: org.kuali.core.rule.DeleteAccountingLineRule.processDeleteAccountingLineBusinessRules(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLineboolean) |
| processExplicitGeneralLedgerPendingEntry | | protected boolean processExplicitGeneralLedgerPendingEntry(AccountingDocument accountingDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry)(Code) | | This method processes all necessary information to build an explicit general ledger entry, and then adds that to the
document.
Parameters:
accountingDocument -
Parameters:
sequenceHelper -
Parameters:
accountingLine -
Parameters:
explicitEntry - boolean True if the explicit entry generation was successful, false otherwise. |
| processGenerateGeneralLedgerPendingEntries | | public boolean processGenerateGeneralLedgerPendingEntries(AccountingDocument accountingDocument, AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)(Code) | | Perform business rules common to all transactional documents when generating general ledger pending entries.
See Also: org.kuali.core.rule.GenerateGeneralLedgerPendingEntriesRule.processGenerateGeneralLedgerPendingEntries(org.kuali.core.document.AccountingDocumentorg.kuali.core.bo.AccountingLineorg.kuali.core.util.GeneralLedgerPendingEntrySequenceHelper) |
| processReviewAccountingLineBusinessRules | | public boolean processReviewAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | This method performs common validation for review of accounting lines. Then calls a custom method for more specific
validation.
See Also: org.kuali.core.rule.ReviewAccountingLineRule.processReviewAccountingLineBusinessRules(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLine) |
| processUpdateAccountingLineBusinessRules | | public boolean processUpdateAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine, AccountingLine updatedAccountingLine)(Code) | | This method performs common validation for update of accounting lines. Then calls a custom method for more specific
validation.
See Also: org.kuali.core.rule.UpdateAccountingLineRule.processUpdateAccountingLineBusinessRules(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLineorg.kuali.core.bo.AccountingLine) |
| putRequiredPropertyError | | public static void putRequiredPropertyError(BusinessObjectEntry boe, String propertyName)(Code) | | Adds a global error for a missing required property. This is used for properties, such as reference origin code, which cannot
be required by the DataDictionary validation because not all documents require them.
Parameters:
boe -
Parameters:
propertyName - |
| reportError | | protected void reportError(String propertyName, String errorKey, String... errorParams)(Code) | | Wrapper around global errorMap.put call, to allow better logging
Parameters:
propertyName -
Parameters:
errorKey -
Parameters:
errorParams - |
| retrievePersistedDocument | | protected AccountingDocument retrievePersistedDocument(AccountingDocument accountingDocument)(Code) | | attempt to retrieve the document from the DB for comparison
Parameters:
accountingDocument - AccountingDocument |
|
|