| org.kuali.kfs.rules.AccountingDocumentRuleBase
 org.kuali.module.financial.rules.DisbursementVoucherDocumentRule
| Method Summary | |
| protected boolean | checkAccountingLineAccountAccessibility(AccountingDocument financialDocument, AccountingLine accountingLine, AccountingLineAction action)
Overrides to call super. | | protected void | customizeExplicitGeneralLedgerPendingEntry(AccountingDocument financialDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry)
Override to change the doc type based on payment method. | | public boolean | isAmountValid(AccountingDocument document, AccountingLine accountingLine)
Override to check for tax accounting lines. | | public boolean | isCoverSheetPrintable(Document document)
| | public boolean | isDebit(AccountingDocument financialDocument, AccountingLine accountingLine)
| | protected boolean | isDocumentBalanceValid(AccountingDocument financialDocument)
Overrides the parent to return true, because Disbursement Voucher documents do not have to balance in order to be submitted
for routing. | | protected boolean | isTargetAccountingLinesRequiredNumberForRoutingMet(AccountingDocument financialDocument)
Overrides the parent to return true, because Disbursement Voucher documents only use the SourceAccountingLines data
structures. | | public boolean | isTravelNonEmplPaymentReason(DisbursementVoucherDocument disbursementVoucherDocument)
| | public boolean | isTravelPrepaidPaymentReason(DisbursementVoucherDocument disbursementVoucherDocument)
| | public boolean | processCustomAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)
Return true if accounting line can be added successfully (i.e. | | protected boolean | processCustomApproveDocumentBusinessRules(ApproveDocumentEvent approveEvent)
Override to check if we are in special handling where the check amount and accounting line total can decrease, else amounts
should not have changed. | | protected boolean | processCustomRouteDocumentBusinessRules(Document document)
Final business rule edits on routing of disbursement voucher document. | | protected boolean | processCustomSaveDocumentBusinessRules(Document document)
Returns true disbursement voucher can be saved successfully (i.e. | | protected boolean | processCustomUpdateAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine originalAccountingLine, AccountingLine updatedAccountingLine)
Returns true if processCustomAddAccountingLineBusinessRules(financialDocument, updatedAccountingLine) returns true. | | public boolean | processGenerateDocumentGeneralLedgerPendingEntries(AccountingDocument financialDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)
Return true if GLPE's are generated successfully (i.e. | | public boolean | validateAccountNumber(AccountingDocument financialDocument, AccountingLine accountingLine)
Checks account number restrictions, including restrictions in parameters table. | | public void | validateDocumentAmounts(DisbursementVoucherDocument document)
Checks the amounts on the document for reconciliation. | | public void | validateEmployeeInformation(DisbursementVoucherDocument document)
Validate attributes of an employee payee for the document. | | public void | validateNonResidentAlienInformation(DisbursementVoucherDocument document)
Validates fields for an alien payment. | | public boolean | validateObjectCode(AccountingDocument financialDocument, AccountingLine accountingLine)
Checks object codes restrictions, including restrictions in parameters table. | | public void | validatePayeeInformation(DisbursementVoucherDocument document)
Validate attributes of the payee for the document. | | public void | validatePayeeInitiatorID(DisbursementVoucherDocument document)
Validates that the payee is not the initiator. | | public void | validatePaymentReason(DisbursementVoucherDocument document)
Validates the payment reason is valid with the other document attributes. |
| DisbursementVoucherDocumentRule | | public DisbursementVoucherDocumentRule()(Code) | | Constructs a DisbursementVoucherDocumentRule instance.
|
| checkAccountingLineAccountAccessibility | | protected boolean checkAccountingLineAccountAccessibility(AccountingDocument financialDocument, AccountingLine accountingLine, AccountingLineAction action)(Code) | | Overrides to call super. If super fails, then we invoke some DV specific rules about FO routing to double check if the
individual has special conditions that they can alter accounting lines by.
Parameters:
financialdocument - submitted disbursement voucher document
Parameters:
accountingLine - accounting line in disbursement voucher
Parameters:
action - accounting line action true if accounting line is accessible
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.checkAccountingLineAccountAccessibility(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLineorg.kuali.module.financial.rules.FinancialDocumentRuleBase.AccountingLineAction) |
| customizeExplicitGeneralLedgerPendingEntry | | protected void customizeExplicitGeneralLedgerPendingEntry(AccountingDocument financialDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry)(Code) | | Override to change the doc type based on payment method. This is needed to pick up different offset definitions.
Parameters:
financialDocument - submitted accounting document
Parameters:
accountingLine - accounting line in submitted accounting document
Parameters:
explicitEntry - explicit GLPE
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.customizeExplicitGeneralLedgerPendingEntry(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLineorg.kuali.module.gl.bo.GeneralLedgerPendingEntry) |
| isAmountValid | | public boolean isAmountValid(AccountingDocument document, AccountingLine accountingLine)(Code) | | Override to check for tax accounting lines. These lines can have negative amounts which the super will reject.
Parameters:
document - submitted document
Parameters:
accountingLine - accounting line document true if there is no non-resident alien tax provided parent class call to isAmountValid(document, accountingLine) returns true ORif there is a non-resident alien tax provided if accounting line sequence number is included in tax line numbers
See Also: org.kuali.core.rule.AccountingLineRule.isAmountValid(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLine) |
| isCoverSheetPrintable | | public boolean isCoverSheetPrintable(Document document)(Code) | | checks the status of the document to see if the coversheet is printable
Parameters:
document - submitted document true if document is not cancelled, initiated, disapproved, exception, or saved |
| isDebit | | public boolean isDebit(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | Rerturns true if accounting line debit
Parameters:
financialDocument - submitted accounting document
Parameters:
accountingLine - accounting line in accounting document true if document is debit
See Also: IsDebitUtils.isDebitConsideringNothingPositiveOnly(FinancialDocumentRuleBaseFinancialDocumentAccountingLine)
See Also: org.kuali.core.rule.AccountingLineRule.isDebit(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLine) |
| isDocumentBalanceValid | | protected boolean isDocumentBalanceValid(AccountingDocument financialDocument)(Code) | | Overrides the parent to return true, because Disbursement Voucher documents do not have to balance in order to be submitted
for routing.
Parameters:
financialDocument - submitted financial document true |
| isTargetAccountingLinesRequiredNumberForRoutingMet | | protected boolean isTargetAccountingLinesRequiredNumberForRoutingMet(AccountingDocument financialDocument)(Code) | | Overrides the parent to return true, because Disbursement Voucher documents only use the SourceAccountingLines data
structures. The list that holds TargetAccountingLines should be empty. This will be checked when the document is "routed" or
submitted to post - it's called automatically by the parent's processRouteDocument method.
Parameters:
financialDocument - submitted accounting document true
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.isTargetAccountingLinesRequiredNumberForRoutingMet(org.kuali.core.document.FinancialDocument) |
| isTravelNonEmplPaymentReason | | public boolean isTravelNonEmplPaymentReason(DisbursementVoucherDocument disbursementVoucherDocument)(Code) | | Returns whether the document's payment reason is for travel by a non-employee
Parameters:
disbursementVoucherDocument - submitted disbursement voucher document true if payment reason is travel by a non-employee |
| isTravelPrepaidPaymentReason | | public boolean isTravelPrepaidPaymentReason(DisbursementVoucherDocument disbursementVoucherDocument)(Code) | | Returns whether the document's payment reason is for prepaid travel
Parameters:
disbursementVoucherDocument - true if payment reason is for pre-paid travel reason |
| processCustomAddAccountingLineBusinessRules | | public boolean processCustomAddAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | Return true if accounting line can be added successfully (i.e. payment reason and payee must be selected before
accounting line can be entered)
Parameters:
financialDocument - submitted financial document
Parameters:
accountingLine - accounting line true if accounting line can be added successfully (i.e. payment reason and payee must be selected beforeaccounting line can be entered)
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.processCustomAddAccountingLineBusinessRules(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLine) |
| processCustomApproveDocumentBusinessRules | | protected boolean processCustomApproveDocumentBusinessRules(ApproveDocumentEvent approveEvent)(Code) | | Override to check if we are in special handling where the check amount and accounting line total can decrease, else amounts
should not have changed.
Parameters:
approveEvent - event fired when approving document true check total did not decrease
See Also: org.kuali.core.rule.DocumentRuleBase.processCustomApproveDocumentBusinessRules(org.kuali.core.rule.event.ApproveDocumentEvent) |
| processCustomRouteDocumentBusinessRules | | protected boolean processCustomRouteDocumentBusinessRules(Document document)(Code) | | Final business rule edits on routing of disbursement voucher document.
Parameters:
document - submitted disbursement voucher document true is disbursement voucher document can be routed with out any problems
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.processCustomRouteDocumentBusinessRules(org.kuali.core.document.FinancialDocument) |
| processCustomUpdateAccountingLineBusinessRules | | protected boolean processCustomUpdateAccountingLineBusinessRules(AccountingDocument financialDocument, AccountingLine originalAccountingLine, AccountingLine updatedAccountingLine)(Code) | | Returns true if processCustomAddAccountingLineBusinessRules(financialDocument, updatedAccountingLine) returns true.
Parameters:
financialDocument - submitted disbursement voucher document
Parameters:
originalAccountingLine - original accounting line
Parameters:
updatedAccountingLine - updated accounting line same value as processCustomAddAccountingLineBusinessRules(financialDocument, updatedAccountingLine)
See Also: org.kuali.module.financial.rules.FinancialDocumentRuleBase.processCustomUpdateAccountingLineBusinessRules(org.kuali.core.document.FinancialDocumentorg.kuali.core.bo.AccountingLineorg.kuali.core.bo.AccountingLine) |
| processGenerateDocumentGeneralLedgerPendingEntries | | public boolean processGenerateDocumentGeneralLedgerPendingEntries(AccountingDocument financialDocument, GeneralLedgerPendingEntrySequenceHelper sequenceHelper)(Code) | | Return true if GLPE's are generated successfully (i.e. there are either 0 GLPE's or 1 GLPE in dibursement voucher document)
Parameters:
financialDocument - submitted financial document
Parameters:
sequenceHelper - helper class to keep track of GLPE sequence true if GLPE's are generated successfully
See Also: org.kuali.core.rule.GenerateGeneralLedgerDocumentPendingEntriesRule.processGenerateDocumentGeneralLedgerPendingEntries(org.kuali.core.document.FinancialDocumentorg.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 financial document
Parameters:
accountingLine - accounting line in submitted accounting document true if account exists, falls withing global function code restrictions, and account's sub fund is in permitted list for payment reason |
| validateDocumentAmounts | | public void validateDocumentAmounts(DisbursementVoucherDocument document)(Code) | | Checks the amounts on the document for reconciliation.
Parameters:
document - submitted disbursement voucher document |
| validateEmployeeInformation | | public void validateEmployeeInformation(DisbursementVoucherDocument document)(Code) | | Validate attributes of an employee payee for the document.
Parameters:
document - submitted disbursement voucher document |
| validateNonResidentAlienInformation | | public void validateNonResidentAlienInformation(DisbursementVoucherDocument document)(Code) | | Validates fields for an alien payment.
Parameters:
document - submitted disbursement voucher document |
| validateObjectCode | | public boolean validateObjectCode(AccountingDocument financialDocument, AccountingLine accountingLine)(Code) | | Checks object codes restrictions, including restrictions in parameters table.
Parameters:
FinancialDocument - submitted accounting document
Parameters:
accountingLine - accounting line in accounting document true if object code exists, is active, and object level and code exist for a provided payment reason |
| validatePayeeInformation | | public void validatePayeeInformation(DisbursementVoucherDocument document)(Code) | | Validate attributes of the payee for the document.
Parameters:
document - submitted disbursement voucher document |
| validatePayeeInitiatorID | | public void validatePayeeInitiatorID(DisbursementVoucherDocument document)(Code) | | Validates that the payee is not the initiator.
Parameters:
document - submitted disbursement voucher document |
| validatePaymentReason | | public void validatePaymentReason(DisbursementVoucherDocument document)(Code) | | Validates the payment reason is valid with the other document attributes.
Parameters:
document - submitted disbursement voucher document |
| 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)
|
|
|