org.kuali.kfs.module.purap.document
Interface AccountsPayableDocument

All Superinterfaces:
AccountingDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.document.Document, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.kns.bo.PersistableBusinessObject, org.apache.ojb.broker.PersistenceBrokerAware, PurapItemOperations, PurchasingAccountsPayableDocument, Serializable, org.kuali.rice.kns.document.TransactionalDocument
All Known Implementing Classes:
AccountsPayableDocumentBase, PaymentRequestDocument, VendorCreditMemoDocument

public interface AccountsPayableDocument
extends PurchasingAccountsPayableDocument

Accounts Payable Document Interface


Method Summary
 boolean approvalAtAccountsPayableReviewAllowed()
          Determines if approval is an option during review.
 boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, PurApItemUseTax offsetUseTax)
           
 Timestamp getAccountsPayableApprovalTimestamp()
           
 String getAccountsPayableProcessorIdentifier()
           
 AccountsPayableItem getAPItemFromPOItem(PurchaseOrderItem poi)
           
 AccountsPayableDocumentSpecificService getDocumentSpecificService()
           
 Timestamp getExtractedTimestamp()
           
 org.kuali.rice.kns.util.KualiDecimal getGrandTotal()
          Retrieves grand total amount for document.
 org.kuali.rice.kns.util.KualiDecimal getInitialAmount()
          Returns the amount entered on the initial screen.
 String getLastActionPerformedByPersonId()
           
 String getNoteLine1Text()
           
 String getNoteLine2Text()
           
 String getNoteLine3Text()
           
 CampusParameter getProcessingCampus()
           
 String getProcessingCampusCode()
           
 PurchaseOrderDocument getPurchaseOrderDocument()
           
 Integer getPurchaseOrderIdentifier()
           
 org.kuali.rice.kns.util.KualiDecimal getTotalRemitTax()
          This method returns the amount of tax to remit to the vendor
 boolean isContinuationAccountIndicator()
           
 boolean isExtracted()
          Determines if document has been extracted.
 boolean isHoldIndicator()
           
 boolean isUnmatchedOverride()
           
 boolean requiresAccountsPayableReviewRouting()
          Determines if review route node is required.
 void setAccountsPayableApprovalTimestamp(Timestamp accountsPayableApprovalTimestamp)
           
 void setAccountsPayableProcessorIdentifier(String accountsPayableProcessorIdentifier)
           
 void setContinuationAccountIndicator(boolean continuationAccountIndicator)
           
 void setExtractedTimestamp(Timestamp extractedTimestamp)
           
 void setHoldIndicator(boolean holdIndicator)
           
 void setLastActionPerformedByPersonId(String lastActionPerformedByPersonId)
           
 void setNoteLine1Text(String noteLine1Text)
           
 void setNoteLine2Text(String noteLine2Text)
           
 void setNoteLine3Text(String noteLine3Text)
           
 void setProcessingCampusCode(String processingCampusCode)
           
 void setPurchaseOrderDocument(PurchaseOrderDocument purchaseOrderDocument)
           
 void setPurchaseOrderIdentifier(Integer purchaseOrderIdentifier)
           
 void setUnmatchedOverride(boolean unmatchedOverride)
           
 
Methods inherited from interface org.kuali.kfs.module.purap.document.PurchasingAccountsPayableDocument
addItem, deleteItem, fixItemReferences, getAccountsPayablePurchasingDocumentLinkIdentifier, getBelowTheLineTypes, getIsATypeOfPODoc, getIsATypeOfPurAPRecDoc, getIsATypeOfPurDoc, getIsPODoc, getIsReqsDoc, getItem, getItemClass, getItemLinePosition, getItems, getPostingYearNextOrCurrent, getPurapDocumentIdentifier, getPurApSourceDocumentIfPossible, getPurApSourceDocumentLabelIfPossible, getStatus, getStatusCode, getTotalDollarAmount, getTotalDollarAmountAboveLineItems, getTotalDollarAmountAllItems, getTotalDollarAmountForTradeIn, getTotalPreTaxDollarAmount, getTotalPreTaxDollarAmountAllItems, getTotalTaxAmount, getTotalTaxAmountAboveLineItems, getTotalTaxAmountAboveLineItems, getTotalTaxAmountAllItems, getTotalTaxAmountWithExclusions, getTradeInItem, getTradeInItems, getTransactionTaxDate, getVendorAddressGeneratedIdentifier, getVendorAddressInternationalProvinceName, getVendorCityName, getVendorCountry, getVendorCountryCode, getVendorCustomerNumber, getVendorDetail, getVendorDetailAssignedIdentifier, getVendorHeaderGeneratedIdentifier, getVendorLine1Address, getVendorLine2Address, getVendorName, getVendorNumber, getVendorPostalCode, getVendorStateCode, isDocumentStoppedInRouteNode, isInquiryRendered, isPostingYearNext, isPostingYearPrior, isUseTaxIndicator, itemSwap, renumberItems, setAccountsPayablePurchasingDocumentLinkIdentifier, setItems, setPurapDocumentIdentifier, setStatusCode, setTotalDollarAmount, setTotalPreTaxDollarAmount, setTotalTaxAmount, setUseTaxIndicator, setVendorAddressGeneratedIdentifier, setVendorAddressInternationalProvinceName, setVendorCityName, setVendorCountryCode, setVendorCustomerNumber, setVendorDetailAssignedIdentifier, setVendorHeaderGeneratedIdentifier, setVendorLine1Address, setVendorLine2Address, setVendorName, setVendorNumber, setVendorPostalCode, setVendorStateCode, shouldGiveErrorForEmptyAccountsProration, templateVendorAddress
 
Methods inherited from interface org.kuali.kfs.sys.document.AccountingDocument
addSourceAccountingLine, addTargetAccountingLine, getAccountingLineParser, getDocumentClassForAccountingLineValueAllowedValidation, getNextSourceLineNumber, getNextTargetLineNumber, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesSectionTitle, getTargetTotal, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines
 
Methods inherited from interface org.kuali.kfs.sys.document.GeneralLedgerPostingDocument
checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries
 
Methods inherited from interface org.kuali.kfs.sys.document.LedgerPostingDocument
getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear
 
Methods inherited from interface org.kuali.kfs.sys.document.FinancialSystemTransactionalDocument
answerSplitNodeQuestion, getDocumentHeader
 
Methods inherited from interface org.kuali.rice.kns.document.Document
addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization
 
Methods inherited from interface org.kuali.rice.kns.bo.PersistableBusinessObject
addNote, buildListOfDeletionAwareLists, deleteNote, getBoNote, getBoNotes, getExtension, getObjectId, getVersionNumber, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber
 
Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject
prepareForWorkflow, refresh
 
Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware
afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate
 
Methods inherited from interface org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource
addPendingEntry, clearAnyGeneralLedgerPendingEntries, generateDocumentGeneralLedgerPendingEntries, generateGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getPostingYear, isDebit
 

Method Detail

getPurchaseOrderIdentifier

Integer getPurchaseOrderIdentifier()

setPurchaseOrderIdentifier

void setPurchaseOrderIdentifier(Integer purchaseOrderIdentifier)

getAccountsPayableProcessorIdentifier

String getAccountsPayableProcessorIdentifier()

setAccountsPayableProcessorIdentifier

void setAccountsPayableProcessorIdentifier(String accountsPayableProcessorIdentifier)

getLastActionPerformedByPersonId

String getLastActionPerformedByPersonId()

setLastActionPerformedByPersonId

void setLastActionPerformedByPersonId(String lastActionPerformedByPersonId)

getProcessingCampusCode

String getProcessingCampusCode()

setProcessingCampusCode

void setProcessingCampusCode(String processingCampusCode)

getAccountsPayableApprovalTimestamp

Timestamp getAccountsPayableApprovalTimestamp()

setAccountsPayableApprovalTimestamp

void setAccountsPayableApprovalTimestamp(Timestamp accountsPayableApprovalTimestamp)

getExtractedTimestamp

Timestamp getExtractedTimestamp()

setExtractedTimestamp

void setExtractedTimestamp(Timestamp extractedTimestamp)

isHoldIndicator

boolean isHoldIndicator()

setHoldIndicator

void setHoldIndicator(boolean holdIndicator)

getNoteLine1Text

String getNoteLine1Text()

setNoteLine1Text

void setNoteLine1Text(String noteLine1Text)

getNoteLine2Text

String getNoteLine2Text()

setNoteLine2Text

void setNoteLine2Text(String noteLine2Text)

getNoteLine3Text

String getNoteLine3Text()

setNoteLine3Text

void setNoteLine3Text(String noteLine3Text)

getProcessingCampus

CampusParameter getProcessingCampus()

getPurchaseOrderDocument

PurchaseOrderDocument getPurchaseOrderDocument()

setPurchaseOrderDocument

void setPurchaseOrderDocument(PurchaseOrderDocument purchaseOrderDocument)

requiresAccountsPayableReviewRouting

boolean requiresAccountsPayableReviewRouting()
Determines if review route node is required.

Returns:
- true if review is required, false otherwise.

approvalAtAccountsPayableReviewAllowed

boolean approvalAtAccountsPayableReviewAllowed()
Determines if approval is an option during review.

Returns:
- true if approval is available during review, false otherwise.

isUnmatchedOverride

boolean isUnmatchedOverride()

setUnmatchedOverride

void setUnmatchedOverride(boolean unmatchedOverride)

getGrandTotal

org.kuali.rice.kns.util.KualiDecimal getGrandTotal()
Retrieves grand total amount for document.

Returns:
- grand total

getTotalRemitTax

org.kuali.rice.kns.util.KualiDecimal getTotalRemitTax()
This method returns the amount of tax to remit to the vendor

Returns:
total of document tax to remit to the vendor null if none

getInitialAmount

org.kuali.rice.kns.util.KualiDecimal getInitialAmount()
Returns the amount entered on the initial screen.

Returns:
- amount entered by user on initial screen

isContinuationAccountIndicator

boolean isContinuationAccountIndicator()

setContinuationAccountIndicator

void setContinuationAccountIndicator(boolean continuationAccountIndicator)

isExtracted

boolean isExtracted()
Determines if document has been extracted.

Returns:
- true if document has been extracted, false otherwise.

getAPItemFromPOItem

AccountsPayableItem getAPItemFromPOItem(PurchaseOrderItem poi)

getDocumentSpecificService

AccountsPayableDocumentSpecificService getDocumentSpecificService()

generateGeneralLedgerPendingEntries

boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                            GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                            PurApItemUseTax offsetUseTax)


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.