org.kuali.ole.module.purap.document.service

Interface AccountsPayableService

All Known Implementing Classes:

AccountsPayableServiceImpl

public interface AccountsPayableService

Contains logic for use by the individual AccountsPayable documents

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAccountsPayableDocument(AccountsPayableDocument apDocument, String currentNodeName) This method cancels a document, it uses DocumentSpecificService to call the actual logic on the PaymentRequestService or CreditMemoService as appropriate.
void	cancelAccountsPayableDocumentByCheckingDocumentStatus(AccountsPayableDocument apDocument, String noteText) This method cancels an AccountsPayableDocument according to the document status.
boolean	canCopyAccountingLinesWithZeroAmount() checks if an accounting line with zero dollar amount can be copied from PO to PREQ.
HashMap<String,ExpiredOrClosedAccountEntry>	expiredOrClosedAccountsList(PurchaseOrderDocument po)
void	generateExpiredOrClosedAccountNote(AccountsPayableDocument document, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Generates a note of where continuation accounts were used and adds them as a note to the document.
void	generateExpiredOrClosedAccountWarning(AccountsPayableDocument document) Adds a warning message to the message list if expired or closed accounts have been used on the document and the document is not in any of these state: Initiate, In Process or Awaiting Accounts Payable Review and the current user is a fiscal user.
HashMap<String,ExpiredOrClosedAccountEntry>	getExpiredOrClosedAccountList(AccountsPayableDocument document) Generates a list of continuation accounts for expired or closed accounts as well as a list of expired or closed accounts with no continuation accounts.
void	performLogicForFullEntryCompleted(PurchasingAccountsPayableDocument purapDocument) Performs all the actions on an update document.
void	processExpiredOrClosedAccount(PurApAccountingLineBase acctLineBase, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Performs the replacement of an expired/closed account with a continuation account.
boolean	purchaseOrderItemEligibleForPayment(PurchaseOrderItem poi) Determines if item is eligible for payment.
void	updateItemList(AccountsPayableDocument apDocument) Updates the item list based on what's eligible to be payed on purchase order.

Method Detail

getExpiredOrClosedAccountList

HashMap<String,ExpiredOrClosedAccountEntry> getExpiredOrClosedAccountList(AccountsPayableDocument document)

Generates a list of continuation accounts for expired or closed accounts as well as a list of expired or closed accounts with no continuation accounts.

Parameters:

document - The accounts payable document whose accounts we are trying to retrieve.

Returns:

A HashMap where the keys are the string representations of the chart and account of the original account and the values are the ExpiredOrClosedAccountEntry.

generateExpiredOrClosedAccountNote

void generateExpiredOrClosedAccountNote(AccountsPayableDocument document,
                                      HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Generates a note of where continuation accounts were used and adds them as a note to the document.

Parameters:

document - The accounts payable document to which we're adding the notes.

expiredOrClosedAccountList - The HashMap where the keys are the string representations of the chart and account of the original account and the values are the ExpiredOrClosedAccountEntry.

generateExpiredOrClosedAccountWarning

void generateExpiredOrClosedAccountWarning(AccountsPayableDocument document)

Adds a warning message to the message list if expired or closed accounts have been used on the document and the document is not in any of these state: Initiate, In Process or Awaiting Accounts Payable Review and the current user is a fiscal user.

Parameters:

document - The accounts payable document to which we're adding the warning message.

processExpiredOrClosedAccount

void processExpiredOrClosedAccount(PurApAccountingLineBase acctLineBase,
                                 HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Performs the replacement of an expired/closed account with a continuation account.

Parameters:

acctLineBase - The accounting line whose chart and account we're going to replace.

expiredOrClosedAccountList - The HashMap where the keys are the string representations of the chart and account of the original account and the values are the ExpiredOrClosedAccountEntry.

cancelAccountsPayableDocument

void cancelAccountsPayableDocument(AccountsPayableDocument apDocument,
                                 String currentNodeName)

This method cancels a document, it uses DocumentSpecificService to call the actual logic on the PaymentRequestService or CreditMemoService as appropriate. In certain cases it will also reopen a closed PurchaseOrderDocument

Parameters:

apDocument - The accounts payable document to be canceled.

currentNodeName - The string representing the current node, which we'll need when we want to update the document status by node. Note: if this is blank it is assumed the request is not coming from workflow.

cancelAccountsPayableDocumentByCheckingDocumentStatus

void cancelAccountsPayableDocumentByCheckingDocumentStatus(AccountsPayableDocument apDocument,
                                                         String noteText)
                                                           throws Exception

This method cancels an AccountsPayableDocument according to the document status.

Parameters:

apDocument - The accounts payable document to be canceled.

noteText - Notes users input when canceling the document

Throws:

Exception

updateItemList

void updateItemList(AccountsPayableDocument apDocument)

Updates the item list based on what's eligible to be payed on purchase order.

Parameters:

apDocument - The accounts payable document containing the items to be updated.

purchaseOrderItemEligibleForPayment

boolean purchaseOrderItemEligibleForPayment(PurchaseOrderItem poi)

Determines if item is eligible for payment.

Parameters:

poi - The purchase order item whose eligibility for payment is to be determined.

Returns:

boolean true if the item is eligible for payment.

performLogicForFullEntryCompleted

void performLogicForFullEntryCompleted(PurchasingAccountsPayableDocument purapDocument)

Performs all the actions on an update document.

Parameters:

purapDocument - PurchasingAccountsPayableDocument

expiredOrClosedAccountsList

HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountsList(PurchaseOrderDocument po)

canCopyAccountingLinesWithZeroAmount

boolean canCopyAccountingLinesWithZeroAmount()

checks if an accounting line with zero dollar amount can be copied from PO to PREQ. This will check the system parameter COPY_ACCOUNTING_LINES_WITH_ZERO_AMOUNT_FROM_PO_TO_PREQ_IND and determines if the line can be copied or not.

Returns:

true if the system parameter value is Y else returns N.