org.kuali.ole.select.document.service

Interface OleInvoiceService

All Superinterfaces:

AccountsPayableDocumentSpecificService, InvoiceService

All Known Implementing Classes:

OleInvoiceServiceImpl

public interface OleInvoiceService
extends InvoiceService

Method Summary

Methods

Modifier and Type	Method and Description
boolean	autoApprovePaymentRequest(OleInvoiceDocument doc)
boolean	autoApprovePaymentRequest(PaymentRequestDocument doc) Checks whether the invoice document is eligible for auto approval.
void	calculateAccount(PurApItem purapItem)
void	calculateProrateItemSurcharge(OleInvoiceDocument invoiceDocument)
void	calculateWithoutProrates(OleInvoiceDocument invoiceDocument)
boolean	canCollapse(String sectionName, String[] collapseSections)
void	completePaymentDocument(OleInvoiceDocument invoiceDocument)
void	convertPOItemToInvoiceItem(OleInvoiceDocument oleInvoiceDocument)
void	createCreditMemoDocument(OleInvoiceDocument invoiceDocument, List<OleInvoiceItem> item, boolean flag)
String	createInvoiceAmountExceedsThresholdText(OleInvoiceDocument oleInvoiceDocument)
String	createInvoiceNoMatchQuestionText(OleInvoiceDocument invoiceDocument)
void	createPaymentRequestOrCreditMemoDocument(OleInvoiceDocument inv)
String	createSubscriptionDateOverlapQuestionText(OleInvoiceDocument invoiceDocument)
void	deleteInvoiceItem(OleInvoiceDocument oleInvoiceDocument)
String[]	getCollapseSections()
String	getCurrencyType(String currencyTypeId)
String	getCurrencyTypeIdFromCurrencyType(String currencyType)
String[]	getDefaultCollapseSections()
OleExchangeRate	getExchangeRate(String currencyTypeId)
OleInvoiceDocument	getInvoiceDocumentById(Integer invoiceIdentifier)
String	getParameter(String name)
String	getPaymentMethodType(String paymentId)
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmountWithExclusionsSubsetItems(String[] excludedTypes, boolean includeBelowTheLine, List<PurApItem> itemsForTotal)
boolean	isDuplicationExists(OleInvoiceDocument invoiceDocument, OLEInvoiceForm invoiceForm, boolean isBlanketApprove)
boolean	isNotificationRequired(OleInvoiceDocument invoiceDocument)
void	populateInvoice(OleInvoiceDocument invoiceDocument)
OleInvoiceDocument	populateInvoiceDocument(OleInvoiceDocument invoiceDocument)
OleInvoiceDocument	populateInvoiceFromPurchaseOrders(OleInvoiceDocument invoiceDocument, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)
OleInvoiceDocument	populateInvoiceItems(OleInvoiceDocument invoiceDocument)
OleInvoiceRecord	populateValuesFromProfile(BibMarcRecord bibMarcRecord)
OleInvoiceDocument	populateVendorDetail(String vendorNumber, OleInvoiceDocument oleInvoiceDocument)
String	routeInvoiceDocument(OleInvoiceDocument invoiceDocument)
String	saveInvoiceDocument(OleInvoiceDocument invoiceDocument)
void	setDefaultAndConstantValuesToInvoiceRecord(OleInvoiceRecord oleInvoiceRecord)
void	setOleBatchProcessProfileBo(OLEBatchProcessProfileBo oleBatchProcessProfileBo)
boolean	validateDepositAccount(OleInvoiceDocument oleInvoiceDocument)
boolean	validateProratedSurcharge(OleInvoiceDocument invoiceDocument)

Methods inherited from interface org.kuali.ole.module.purap.document.service.InvoiceService

addHoldOnInvoice, allowBackpost, autoApproveInvoice, autoApproveInvoice, autoApproveInvoices, autoApprovePaymentRequest, calculateInvoice, calculatePayDate, calculateTaxArea, cancelExtractedInvoice, changeVendor, clearTax, createPreqDocumentDescription, encumberedItemExistsForInvoicing, getImmediateInvoicesToExtract, getInvoiceByDocumentNumber, getInvoiceById, getInvoicesByPOIdInvoiceAmountInvoiceDate, getInvoicesByPurchaseOrderId, getInvoicesByVendorNumber, getInvoicesByVendorNumberInvoiceNumber, getInvoicesToExtract, getInvoicesToExtractByCM, getInvoicesToExtractByVendor, getInvoicesToExtractSpecialPayments, getInvoiceToExtractByChart, getParameter, getParameterBoolean, hasActiveInvoicesForPurchaseOrder, hasDiscountItem, invoiceDuplicateMessages, isExtracted, isInvoiceDateAfterToday, isPurchaseOrderValidForInvoiceDocumentCreation, markPaid, populateAndSaveInvoice, processInvoiceInReceivingStatus, removeHoldOnInvoice, removeIneligibleAdditionalCharges, removeRequestCancelOnInvoice, requestCancelOnInvoice, resetExtractedInvoice

Methods inherited from interface org.kuali.ole.module.purap.document.service.AccountsPayableDocumentSpecificService

generateGLEntriesCreateAccountsPayableDocument, getPersonForCancel, poItemEligibleForAp, shouldPurchaseOrderBeReversed, takePurchaseOrderCancelAction, updateStatusByNode

Method Detail

completePaymentDocument

void completePaymentDocument(OleInvoiceDocument invoiceDocument)

calculateProrateItemSurcharge

void calculateProrateItemSurcharge(OleInvoiceDocument invoiceDocument)

validateProratedSurcharge

boolean validateProratedSurcharge(OleInvoiceDocument invoiceDocument)

calculateWithoutProrates

void calculateWithoutProrates(OleInvoiceDocument invoiceDocument)

autoApprovePaymentRequest

boolean autoApprovePaymentRequest(PaymentRequestDocument doc)

Checks whether the invoice document is eligible for auto approval. If so, then updates the status of the document to auto approved and calls the documentService to blanket approve the document, then returns false. If the document is not eligible for auto approval then returns true.

Parameters:

doc - The invoice document to be auto approved.

Returns:

boolean true if the invoice document is not eligible for auto approval.

Throws:

RuntimeException - To indicate to Spring transactional management that the transaction for this document should be rolled back

createPaymentRequestOrCreditMemoDocument

void createPaymentRequestOrCreditMemoDocument(OleInvoiceDocument inv)

populateInvoiceFromPurchaseOrders

OleInvoiceDocument populateInvoiceFromPurchaseOrders(OleInvoiceDocument invoiceDocument,
                                                   HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

populateInvoice

void populateInvoice(OleInvoiceDocument invoiceDocument)

populateVendorDetail

OleInvoiceDocument populateVendorDetail(String vendorNumber,
                                      OleInvoiceDocument oleInvoiceDocument)

createCreditMemoDocument

void createCreditMemoDocument(OleInvoiceDocument invoiceDocument,
                            List<OleInvoiceItem> item,
                            boolean flag)

getInvoiceDocumentById

OleInvoiceDocument getInvoiceDocumentById(Integer invoiceIdentifier)

saveInvoiceDocument

String saveInvoiceDocument(OleInvoiceDocument invoiceDocument)
                           throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

routeInvoiceDocument

String routeInvoiceDocument(OleInvoiceDocument invoiceDocument)
                            throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

autoApprovePaymentRequest

boolean autoApprovePaymentRequest(OleInvoiceDocument doc)

populateInvoiceItems

OleInvoiceDocument populateInvoiceItems(OleInvoiceDocument invoiceDocument)

populateInvoiceDocument

OleInvoiceDocument populateInvoiceDocument(OleInvoiceDocument invoiceDocument)

calculateAccount

void calculateAccount(PurApItem purapItem)

convertPOItemToInvoiceItem

void convertPOItemToInvoiceItem(OleInvoiceDocument oleInvoiceDocument)

createInvoiceNoMatchQuestionText

String createInvoiceNoMatchQuestionText(OleInvoiceDocument invoiceDocument)

createSubscriptionDateOverlapQuestionText

String createSubscriptionDateOverlapQuestionText(OleInvoiceDocument invoiceDocument)

getParameter

String getParameter(String name)

getTotalDollarAmountWithExclusionsSubsetItems

org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmountWithExclusionsSubsetItems(String[] excludedTypes,
                                                                                           boolean includeBelowTheLine,
                                                                                           List<PurApItem> itemsForTotal)

getCollapseSections

String[] getCollapseSections()

getDefaultCollapseSections

String[] getDefaultCollapseSections()

canCollapse

boolean canCollapse(String sectionName,
                  String[] collapseSections)

isDuplicationExists

boolean isDuplicationExists(OleInvoiceDocument invoiceDocument,
                          OLEInvoiceForm invoiceForm,
                          boolean isBlanketApprove)

getPaymentMethodType

String getPaymentMethodType(String paymentId)

validateDepositAccount

boolean validateDepositAccount(OleInvoiceDocument oleInvoiceDocument)

isNotificationRequired

boolean isNotificationRequired(OleInvoiceDocument invoiceDocument)

createInvoiceAmountExceedsThresholdText

String createInvoiceAmountExceedsThresholdText(OleInvoiceDocument oleInvoiceDocument)

populateValuesFromProfile

OleInvoiceRecord populateValuesFromProfile(BibMarcRecord bibMarcRecord)

setOleBatchProcessProfileBo

void setOleBatchProcessProfileBo(OLEBatchProcessProfileBo oleBatchProcessProfileBo)

setDefaultAndConstantValuesToInvoiceRecord

void setDefaultAndConstantValuesToInvoiceRecord(OleInvoiceRecord oleInvoiceRecord)

getCurrencyType

String getCurrencyType(String currencyTypeId)

getExchangeRate

OleExchangeRate getExchangeRate(String currencyTypeId)

getCurrencyTypeIdFromCurrencyType

String getCurrencyTypeIdFromCurrencyType(String currencyType)

deleteInvoiceItem

void deleteInvoiceItem(OleInvoiceDocument oleInvoiceDocument)