org.kuali.ole.module.purap.document

Class InvoiceDocument

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

org.kuali.ole.sys.document.LedgerPostingDocumentBase

org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

org.kuali.ole.sys.document.AccountingDocumentBase

org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocumentBase

org.kuali.ole.module.purap.document.AccountsPayableDocumentBase

org.kuali.ole.module.purap.document.InvoiceDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, AccountsPayableDocument, PurapItemOperations, PurchasingAccountsPayableDocument, AccountingDocument, AmountTotaling, FinancialSystemDocument, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

OleInvoiceDocument

public class InvoiceDocument
extends AccountsPayableDocumentBase

Payment Request Document Business Object. Contains the fields associated with the main document table.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accountsPayableRequestCancelIdentifier
protected Integer	alternateVendorDetailAssignedIdentifier
protected Integer	alternateVendorHeaderGeneratedIdentifier
protected boolean	immediatePaymentIndicator
protected boolean	invoiceCancelIndicator
protected PurchaseOrderCostSource	invoiceCostSource
protected String	invoiceCostSourceCode
protected Date	invoiceDate
protected boolean	invoiceElectronicInvoiceIndicator
protected String	invoiceNumber
protected Date	invoicePayDate
protected boolean	invoicePositiveApprovalIndicator
protected static org.apache.log4j.Logger	LOG
protected Integer	originalVendorDetailAssignedIdentifier
protected Integer	originalVendorHeaderGeneratedIdentifier
protected boolean	paymentAttachmentIndicator
protected Timestamp	paymentPaidTimestamp
protected String	primaryVendorName
protected Date	purchaseOrderEndDate
protected String	purchaseOrderNotes
protected boolean	receivingDocumentRequiredIndicator
protected RecurringPaymentType	recurringPaymentType
protected String	recurringPaymentTypeCode
protected Integer	requisitionIdentifier
protected String	specialHandlingInstructionLine1Text
protected String	specialHandlingInstructionLine2Text
protected String	specialHandlingInstructionLine3Text
protected String	taxClassificationCode
protected String	taxCountryCode
protected Boolean	taxExemptTreatyIndicator
protected BigDecimal	taxFederalPercent
protected Boolean	taxForeignSourceIndicator
protected Boolean	taxGrossUpIndicator
protected String	taxNQIId
protected Boolean	taxOtherExemptIndicator
protected org.kuali.rice.core.api.util.type.KualiDecimal	taxSpecialW4Amount
protected BigDecimal	taxStatePercent
protected Boolean	taxUSAIDPerDiemIndicator
protected org.kuali.rice.core.api.util.type.KualiDecimal	vendorInvoiceAmount
protected PaymentTermType	vendorPaymentTerms
protected String	vendorPaymentTermsCode
protected ShippingPaymentTerms	vendorShippingPaymentTerms
protected String	vendorShippingPaymentTermsCode
protected String	vendorShippingTitleCode

Fields inherited from class org.kuali.ole.module.purap.document.AccountsPayableDocumentBase

accountsPayableApprovalTimestamp, accountsPayableProcessorIdentifier, bank, bankCode, chartOfAccountsCode, closePurchaseOrderIndicator, continuationAccountIndicator, debitCreditCodeForGLEntries, extractedTimestamp, generateEncumbranceEntries, holdIndicator, lastActionPerformedByPersonId, noteLine1Text, noteLine2Text, noteLine3Text, offsetUseTax, organizationCode, processingCampus, processingCampusCode, purchaseOrderDocument, purchaseOrderIdentifier, reopenPurchaseOrderIndicator, unmatchedOverride

Fields inherited from class org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocumentBase

accountDistributionMethod, accountsForRouting, accountsPayablePurchasingDocumentLinkIdentifier, allowDeleteAwareCollection, belowTheLineTypes, calculated, items, licenseReqmt, orderType, overrideWorkflowButtons, purapDocumentIdentifier, purchaseOrderTypeId, relatedViews, sensitive, statusCode, useTaxIndicator, vendorAddressGeneratedIdentifier, vendorAddressInternationalProvinceName, vendorAttentionName, vendorCityName, vendorCountry, vendorCountryCode, vendorCustomerNumber, vendorDetail, vendorDetailAssignedIdentifier, vendorHeaderGeneratedIdentifier, vendorLine1Address, vendorLine2Address, vendorName, vendorNumber, vendorPostalCode, vendorStateCode

Fields inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

dataDictionaryEntry, nextSourceLineNumber, nextTargetLineNumber, sourceAccountingLineClass, sourceAccountingLines, targetAccountingLineClass, targetAccountingLines

Fields inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

generalLedgerPendingEntries

Fields inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

accountingPeriod, accountingPeriodService, checkPostingYearForCopy, dataDictionaryService, dateTimeService, postingPeriodCode, postingYear

Fields inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

documentHeader, documentNumber

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
InvoiceDocument() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	answerSplitNodeQuestion(String nodeName) Provides answers to the following splits: PurchaseWasReceived VendorIsEmployeeOrNonResidentAlien
void	clearInitFields() Perform logic needed to clear the initial fields on a PRQS Document
protected void	closePurchaseOrder()
void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) Forces general ledger entries to be approved, does not wait for payment request document final approval.
void	doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event) Generates correcting entries to the GL if accounts are modified.
boolean	documentHasNoImagesAttached() Checks all documents notes for attachments.
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) Override to call super and then iterate over all GLPEs and update the approved code appropriately.
Date	getAccountsPayableApprovalDateForSearching()
String	getAccountsPayableRequestCancelIdentifier()
String	getAccountsPayableRequestCancelPersonName() Returns the name of who requested cancel.
Integer	getAlternateVendorDetailAssignedIdentifier()
Integer	getAlternateVendorHeaderGeneratedIdentifier()
protected List<String>	getCurrentRouteLevels(org.kuali.rice.kew.api.WorkflowDocument workflowDocument) Determinines the route levels for a given document.
protected String	getCustomDocumentTitle() Returns a custom document title based on the workflow document title.
AccountsPayableDocumentSpecificService	getDocumentSpecificService()
String	getDocumentTitle()
PurApAccountingLine	getFirstAccount() Returns the first payment item's first account (assuming the item list is sequentially ordered).
org.kuali.rice.core.api.util.type.KualiDecimal	getGrandPreTaxTotal()
org.kuali.rice.core.api.util.type.KualiDecimal	getGrandPreTaxTotalExcludingDiscount()
org.kuali.rice.core.api.util.type.KualiDecimal	getGrandTaxAmount()
org.kuali.rice.core.api.util.type.KualiDecimal	getGrandTaxAmountExcludingDiscount()
org.kuali.rice.core.api.util.type.KualiDecimal	getGrandTotal() Retrieves grand total amount for document.
org.kuali.rice.core.api.util.type.KualiDecimal	getGrandTotalExcludingDiscount()
boolean	getImmediatePaymentIndicator()
org.kuali.rice.core.api.util.type.KualiDecimal	getInitialAmount() Returns the amount entered on the initial screen.
boolean	getInvoiceCancelIndicator()
PurchaseOrderCostSource	getInvoiceCostSource()
String	getInvoiceCostSourceCode()
Date	getInvoiceDate()
boolean	getInvoiceElectronicInvoiceIndicator()
String	getInvoiceNumber()
Date	getInvoicePayDate()
boolean	getInvoicePositiveApprovalIndicatorForSearching()
PurApItem	getItem(int pos) Gets the item at the specified index.
Class	getItemClass() Returns the Item Class.
org.kuali.rice.core.api.util.type.KualiDecimal	getItemTotalPoEncumbranceAmount() Returns the total encumbered amount from the purchase order excluding below the line.
org.kuali.rice.core.api.util.type.KualiDecimal	getItemTotalPoEncumbranceAmountRelieved()
org.kuali.rice.core.api.util.type.KualiDecimal	getItemTotalPoEncumbranceAmountRelieved(boolean includeBelowTheLine)
org.kuali.rice.core.api.util.type.KualiDecimal	getItemTotalPoPaidAmount() The total that was paid on the po excluding below the line
Class	getItemUseTaxClass()
org.kuali.rice.core.api.util.type.KualiDecimal	getLineItemPreTaxTotal()
org.kuali.rice.core.api.util.type.KualiDecimal	getLineItemTaxAmount()
org.kuali.rice.core.api.util.type.KualiDecimal	getLineItemTotal()
Integer	getOriginalVendorDetailAssignedIdentifier()
Integer	getOriginalVendorHeaderGeneratedIdentifier()
String	getPaidIndicatorForResult()
boolean	getPaymentAttachmentIndicator()
Timestamp	getPaymentPaidTimestamp()
String	getPoDocumentTypeForAccountsPayableDocumentCancel() Helper method to be called from custom prepare for save and to be overriden by sub class.
Integer	getPostingYearPriorOrCurrent()
String	getPrimaryVendorName()
PurchaseOrderDocument	getPurApSourceDocumentIfPossible() Returns the source of this Purchasing Accounts Payable Document if exists.
String	getPurApSourceDocumentLabelIfPossible() Returns the label of the source of this Purchasing Accounts Payable Document if exists.
PurchaseOrderDocument	getPurchaseOrderDocument()
PurchaseOrderDocument	getPurchaseOrderDocument(Integer poID)
List<OlePurchaseOrderDocument>	getPurchaseOrderDocuments()
Date	getPurchaseOrderEndDate()
String	getPurchaseOrderNotes()
boolean	getReceivingDocumentRequiredIndicatorForSearching()
RecurringPaymentType	getRecurringPaymentType()
String	getRecurringPaymentTypeCode()
String	getRequestCancelIndicatorForResult()
Integer	getRequisitionIdentifier()
String	getSpecialHandlingInstructionLine1Text()
String	getSpecialHandlingInstructionLine2Text()
String	getSpecialHandlingInstructionLine3Text()
String	getTaxClassificationCode()
String	getTaxCountryCode()
Boolean	getTaxExemptTreatyIndicator()
BigDecimal	getTaxFederalPercent()
org.kuali.rice.core.api.util.type.KualiDecimal	getTaxFederalPercentShort()
Boolean	getTaxForeignSourceIndicator()
Boolean	getTaxGrossUpIndicator()
String	getTaxNQIId()
Boolean	getTaxOtherExemptIndicator()
org.kuali.rice.core.api.util.type.KualiDecimal	getTaxSpecialW4Amount()
BigDecimal	getTaxStatePercent()
org.kuali.rice.core.api.util.type.KualiDecimal	getTaxStatePercentShort()
Boolean	getTaxUSAIDPerDiemIndicator()
protected String	getTitleIndicator() Determines the indicator text that will appear in the workflow document title
Date	getTransactionTaxDate()
org.kuali.rice.core.api.util.type.KualiDecimal	getVendorInvoiceAmount()
PaymentTermType	getVendorPaymentTerms()
String	getVendorPaymentTermsCode()
ShippingPaymentTerms	getVendorShippingPaymentTerms()
String	getVendorShippingPaymentTermsCode()
String	getVendorShippingTitleCode()
void	initiateDocument() Perform logic needed to initiate PRQS Document
protected boolean	isAttachmentRequired() Checks whether an attachment is required
boolean	isBoNotesSupport()
boolean	isDiscount()
boolean	isEnableInvoicePositiveApprovalIndicator() Decides whether invoicePositiveApprovalIndicator functionality shall be enabled according to the controlling parameter.
boolean	isEnableReceivingDocumentRequiredIndicator() Decides whether receivingDocumentRequiredIndicator functionality shall be enabled according to the controlling parameter.
boolean	isInquiryRendered() Overrides the method in PurchasingAccountsPayableDocumentBase to add the criteria specific to Payment Request Document.
boolean	isInvoiceCancelIndicator()
boolean	isInvoiceCancelIndicatorForSearching()
boolean	isInvoicePositiveApprovalIndicator() Gets the invoicePositiveApprovalIndicator attribute.
boolean	isReceivingDocumentRequiredIndicator() Gets the receivingDocumentRequiredIndicator attribute.
boolean	isReceivingRequirementMet() Determine if the receiving requirement has been met for all items on the payment request.
protected boolean	isVendorEmployeeOrNonResidentAlien()
void	populateInvoiceFromPurchaseOrder(PurchaseOrderDocument po) Populates a preq from a PO - delegate method
void	populateInvoiceFromPurchaseOrder(PurchaseOrderDocument po, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Populates a preq from a PO
void	prepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event) Populates the payment request document, then continues with preparing for save.
boolean	processNodeChange(String newNodeName, String oldNodeName) Hook to allow processing after a route level is passed.
void	saveDocumentFromPostProcessing() Hook point to allow processing after a save.
void	setAccountsPayableRequestCancelIdentifier(String accountsPayableRequestCancelIdentifier)
void	setAlternateVendorDetailAssignedIdentifier(Integer alternateVendorDetailAssignedIdentifier)
void	setAlternateVendorHeaderGeneratedIdentifier(Integer alternateVendorHeaderGeneratedIdentifier)
void	setGrandTotalExcludingDiscount(org.kuali.rice.core.api.util.type.KualiDecimal amount) This method is here due to a setter requirement by the htmlControlAttribute
void	setImmediatePaymentIndicator(boolean immediatePaymentIndicator)
void	setInvoiceCancelIndicator(boolean invoiceCancelIndicator)
void	setInvoiceCostSource(PurchaseOrderCostSource invoiceCostSource)
void	setInvoiceCostSourceCode(String invoiceCostSourceCode)
void	setInvoiceDate(Date invoiceDate)
void	setInvoiceElectronicInvoiceIndicator(boolean invoiceElectronicInvoiceIndicator)
void	setInvoiceNumber(String invoiceNumber)
void	setInvoicePayDate(Date invoicePayDate)
void	setInvoicePositiveApprovalIndicator(boolean invoicePositiveApprovalIndicator) Sets the invoicePositiveApprovalIndicator attribute value.
void	setItemTotalPoEncumbranceAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount) Exists due to a setter requirement by the htmlControlAttribute
void	setItemTotalPoEncumbranceAmountRelieved(org.kuali.rice.core.api.util.type.KualiDecimal amount) Exists due to a setter requirement by the htmlControlAttribute
void	setItemTotalPoPaidAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount) Exists due to a setter requirement by the htmlControlAttribute
void	setOriginalVendorDetailAssignedIdentifier(Integer originalVendorDetailAssignedIdentifier)
void	setOriginalVendorHeaderGeneratedIdentifier(Integer originalVendorHeaderGeneratedIdentifier)
void	setPaymentAttachmentIndicator(boolean paymentAttachmentIndicator)
void	setPaymentPaidTimestamp(Timestamp paymentPaidTimestamp)
void	setPrimaryVendorName(String primaryVendorName) Deprecated.
void	setPurchaseOrderDocuments(List<OlePurchaseOrderDocument> purchaseOrderDocuments)
void	setPurchaseOrderEndDate(Date purchaseOrderEndDate)
void	setPurchaseOrderNotes(String purchaseOrderNotes)
void	setReceivingDocumentRequiredIndicator(boolean receivingDocumentRequiredIndicator) Sets the receivingDocumentRequiredIndicator attribute value.
void	setRecurringPaymentType(RecurringPaymentType recurringPaymentType)
void	setRecurringPaymentTypeCode(String recurringPaymentTypeCode)
void	setRequisitionIdentifier(Integer requisitionIdentifier)
void	setSpecialHandlingInstructionLine1Text(String specialHandlingInstructionLine1Text)
void	setSpecialHandlingInstructionLine2Text(String specialHandlingInstructionLine2Text)
void	setSpecialHandlingInstructionLine3Text(String specialHandlingInstructionLine3Text)
void	setTaxClassificationCode(String taxClassificationCode)
void	setTaxCountryCode(String taxCountryCode)
void	setTaxExemptTreatyIndicator(Boolean taxExemptTreatyIndicator)
void	setTaxFederalPercent(BigDecimal taxFederalPercent)
void	setTaxForeignSourceIndicator(Boolean taxForeignSourceIndicator)
void	setTaxGrossUpIndicator(Boolean taxGrossUpIndicator)
void	setTaxNQIId(String taxNQIId)
void	setTaxOtherExemptIndicator(Boolean taxOtherExemptIndicator)
void	setTaxSpecialW4Amount(org.kuali.rice.core.api.util.type.KualiDecimal taxSpecialW4Amount)
void	setTaxStatePercent(BigDecimal taxStatePercent)
void	setTaxUSAIDPerDiemIndicator(Boolean taxUSAIDPerDiemIndicator)
void	setVendorInvoiceAmount(org.kuali.rice.core.api.util.type.KualiDecimal vendorInvoiceAmount)
void	setVendorPaymentTerms(PaymentTermType vendorPaymentTerms)
void	setVendorPaymentTermsCode(String vendorPaymentTermsCode)
void	setVendorShippingPaymentTerms(ShippingPaymentTerms vendorShippingPaymentTerms)
void	setVendorShippingPaymentTermsCode(String vendorShippingPaymentTermsCode)
void	setVendorShippingTitleCode(String vendorShippingTitleCode)
protected boolean	shouldWaitForReceiving() Payment Request needs to wait for receiving if the receiving requirements have NOT been met.

Methods inherited from class org.kuali.ole.module.purap.document.AccountsPayableDocumentBase

approvalAtAccountsPayableReviewAllowed, customizeOffsetGeneralLedgerPendingEntry, doRouteLevelChange, generateGeneralLedgerPendingEntries, getAccountsPayableApprovalTimestamp, getAccountsPayableProcessorIdentifier, getAPItemFromPOItem, getBank, getBankCode, getChartOfAccountsCode, getDebitCreditCodeForGLEntries, getDocumentChartOfAccountsCodeForSearching, getDocumentOrganizationCodeForSearching, getDocumentType, getExtractedIndicatorForSearching, getExtractedTimestamp, getHoldIndicatorForResult, getLastActionPerformedByPersonId, getLastActionPerformedByPersonName, getLastActionPerformedByUser, getNoteLine1Text, getNoteLine2Text, getNoteLine3Text, getOrganizationCode, getProcessingCampus, getProcessingCampusCode, getProcessingCampusCodeForSearch, getPurchaseOrderIdentifier, getTotalRemitTax, isClosePurchaseOrderIndicator, isContinuationAccountIndicator, isExtracted, isGenerateEncumbranceEntries, isHoldIndicator, isHoldIndicatorForSearching, isReopenPurchaseOrderIndicator, isUnmatchedOverride, populateDocumentForRouting, removeGeneralLedgerPendingEntries, requiresAccountsPayableReviewRouting, setAccountsPayableApprovalTimestamp, setAccountsPayableProcessorIdentifier, setBank, setBankCode, setChartOfAccountsCode, setClosePurchaseOrderIndicator, setContinuationAccountIndicator, setDebitCreditCodeForGLEntries, setExtractedTimestamp, setGenerateEncumbranceEntries, setGrandTotal, setHoldIndicator, setLastActionPerformedByPersonId, setLineItemTotal, setNoteLine1Text, setNoteLine2Text, setNoteLine3Text, setOrganizationCode, setProcessingCampus, setProcessingCampusCode, setPurchaseOrderDocument, setPurchaseOrderIdentifier, setReopenPurchaseOrderIndicator, setUnmatchedOverride, shouldGiveErrorForEmptyAccountsProration, updateExtendedPriceOnItems

Methods inherited from class org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocumentBase

addItem, buildDocumentTitle, buildListOfDeletionAwareLists, customPrepareForSave, deleteItem, documentPerformsSufficientFundsCheck, fixItemReferences, getAccountDistributionMethod, getAccountsForRouting, getAccountsPayablePurchasingDocumentLinkIdentifier, getAccountTotalGLEntryAmount, getBelowTheLineTypes, getDeletionAwareAccountingLines, getFirstPendingGLEntry, getIsATypeOfPODoc, getIsATypeOfPurAPRecDoc, getIsATypeOfPurDoc, getIsPODoc, getIsReqsDoc, getItemByItemIdentifier, getItemByLineNumber, getItemByStringIdentifier, getItemLinePosition, getItems, getLicenseURL, getNeedWarningRelatedPOs, getNoteType, getOrderType, getOverrideWorkflowButtons, getPersistedSourceAccountingLinesForComparison, getPostingPeriodCodeFromPendingGLEntries, getPostingYearFromPendingGLEntries, getPostingYearNextOrCurrent, getPurapDocumentIdentifier, getPurchaseOrderTypeId, getRelatedViews, getSourceAccountingLines, getSourceAccountingLinesForComparison, getStatusCode, getTotalDollarAmount, getTotalDollarAmountAboveLineItems, getTotalDollarAmountAboveLineItems, getTotalDollarAmountAllItems, getTotalDollarAmountForTradeIn, getTotalDollarAmountWithExclusions, getTotalDollarAmountWithExclusionsSubsetItems, getTotalPreTaxDollarAmount, getTotalPreTaxDollarAmountAboveLineItems, getTotalPreTaxDollarAmountAboveLineItems, getTotalPreTaxDollarAmountAllItems, getTotalPreTaxDollarAmountWithExclusions, getTotalTaxAmount, getTotalTaxAmountAboveLineItems, getTotalTaxAmountAboveLineItems, getTotalTaxAmountAllItems, getTotalTaxAmountWithExclusions, getTradeInItem, getTradeInItems, getVendorAddressGeneratedIdentifier, getVendorAddressInternationalProvinceName, getVendorAttentionName, getVendorCityName, getVendorCountry, getVendorCountryCode, getVendorCustomerNumber, getVendorDetail, getVendorDetailAssignedIdentifier, getVendorHeaderGeneratedIdentifier, getVendorLine1Address, getVendorLine2Address, getVendorName, getVendorNumber, getVendorPostalCode, getVendorStateCode, isAccountSummaryFlag, isAdditionalInstitutionalInfoFlag, isAdHocRecipientsFlag, isCalculated, isCreditMemoInfoFlag, isDebit, isDeliveryFlag, isDocumentStoppedInRouteNode, isDuplicateAccountingLine, isGeneralEntriesFlag, isInvoiceInfoFlag, isNotesAndAttachmentFlag, isOverviewFlag, isPaymentHistoryFlag, isPaymentInfoFlag, isPostingYearNext, isPostingYearPrior, isProcessItemsFlag, isRelatedDocumentsFlag, isRouteLogFlag, isSensitive, isTitlesFlag, isUseTaxIndicator, isVendorFlag, itemSwap, logAndThrowRuntimeException, logAndThrowRuntimeException, populateAccountsForRouting, processAfterRetrieve, refreshNonUpdateableReferences, renumberItems, setAccountDistributionMethod, setAccountsForRouting, setAccountsPayablePurchasingDocumentLinkIdentifier, setAccountSummaryFlag, setAdditionalInstitutionalInfoFlag, setAdHocRecipientsFlag, setCalculated, setCreditMemoInfoFlag, setDeliveryFlag, setGeneralEntriesFlag, setInvoiceInfoFlag, setItems, setNotesAndAttachmentFlag, setOleUrlResolver, setOrderType, setOverrideWorkflowButtons, setOverviewFlag, setPaymentHistoryFlag, setPaymentInfoFlag, setPostingYear, setProcessItemsFlag, setPurapDocumentIdentifier, setPurchaseOrderTypeId, setPurchaseOrderTypeId, setRelatedDocumentsFlag, setRelatedViews, setRouteLogFlag, setStatusCode, setTitlesFlag, setTotalDollarAmount, setTotalPreTaxDollarAmount, setTotalTaxAmount, setUseTaxIndicator, setVendorAddressGeneratedIdentifier, setVendorAddressInternationalProvinceName, setVendorAttentionName, setVendorCityName, setVendorCountry, setVendorCountryCode, setVendorCustomerNumber, setVendorDetail, setVendorDetailAssignedIdentifier, setVendorFlag, setVendorHeaderGeneratedIdentifier, setVendorLine1Address, setVendorLine2Address, setVendorName, setVendorNumber, setVendorPostalCode, setVendorStateCode, templateVendorAddress

Methods inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

addSourceAccountingLine, addTargetAccountingLine, buildAccountingLineMap, copyAccountingLines, generateDocumentGeneralLedgerPendingEntries, generateEvents, generateGeneralLedgerPendingEntries, generateSaveEvents, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesForComparison, getTargetAccountingLinesSectionTitle, getTargetTotal, isDocumentFinalOrProcessed, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, toErrorCorrection, updatePostingYearForAccountingLines

Methods inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

Methods inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

createInitialAccountingPeriod, getAccountingPeriod, getAccountingPeriodCompositeString, getAccountingPeriodService, getDataDictionaryService, getDateTimeService, getFinancialDocumentTypeCode, getPostingPeriodCode, getPostingYear, retrieveCurrentAccountingPeriod, setAccountingPeriod, setAccountingPeriodCompositeString, setPostingPeriodCode

Methods inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, prepareForSave, setApplicationDocumentStatus, setDocumentHeader, updateAndSaveAppDocStatus

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, postLoad, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument

addItem, deleteItem, fixItemReferences, getAccountsPayablePurchasingDocumentLinkIdentifier, getApplicationDocumentStatus, getBelowTheLineTypes, getIsATypeOfPODoc, getIsATypeOfPurAPRecDoc, getIsATypeOfPurDoc, getIsPODoc, getIsReqsDoc, getItemLinePosition, getItems, getPostingYearNextOrCurrent, getPurapDocumentIdentifier, getTotalDollarAmount, getTotalDollarAmountAboveLineItems, getTotalDollarAmountAllItems, getTotalDollarAmountForTradeIn, getTotalPreTaxDollarAmount, getTotalPreTaxDollarAmountAllItems, getTotalTaxAmount, getTotalTaxAmountAboveLineItems, getTotalTaxAmountAboveLineItems, getTotalTaxAmountAllItems, getTotalTaxAmountWithExclusions, getTradeInItem, getTradeInItems, getVendorAddressGeneratedIdentifier, getVendorAddressInternationalProvinceName, getVendorCityName, getVendorCountry, getVendorCountryCode, getVendorCustomerNumber, getVendorDetail, getVendorDetailAssignedIdentifier, getVendorHeaderGeneratedIdentifier, getVendorLine1Address, getVendorLine2Address, getVendorName, getVendorNumber, getVendorPostalCode, getVendorStateCode, isCalculated, isDocumentStoppedInRouteNode, isPostingYearNext, isPostingYearPrior, isUseTaxIndicator, itemSwap, renumberItems, setAccountsPayablePurchasingDocumentLinkIdentifier, setApplicationDocumentStatus, setCalculated, setItems, setPurapDocumentIdentifier, setTotalDollarAmount, setTotalPreTaxDollarAmount, setTotalTaxAmount, setUseTaxIndicator, setVendorAddressGeneratedIdentifier, setVendorAddressInternationalProvinceName, setVendorCityName, setVendorCountryCode, setVendorCustomerNumber, setVendorDetailAssignedIdentifier, setVendorHeaderGeneratedIdentifier, setVendorLine1Address, setVendorLine2Address, setVendorName, setVendorNumber, setVendorPostalCode, setVendorStateCode, templateVendorAddress

Methods inherited from interface org.kuali.ole.sys.document.AccountingDocument

addSourceAccountingLine, addTargetAccountingLine, getAccountingLineParser, getDocumentClassForAccountingLineValueAllowedValidation, getNextSourceLineNumber, getNextTargetLineNumber, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesSectionTitle, getTargetTotal, isDocumentFinalOrProcessed, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines

Methods inherited from interface org.kuali.ole.sys.document.GeneralLedgerPostingDocument

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

Methods inherited from interface org.kuali.ole.sys.document.LedgerPostingDocument

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.ole.sys.document.FinancialSystemDocument

getFinancialSystemDocumentHeader

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, postProcessSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.ole.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, generateDocumentGeneralLedgerPendingEntries, generateGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getPostingYear, isDebit

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

invoiceDate

protected Date invoiceDate

invoiceNumber

protected String invoiceNumber

vendorInvoiceAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal vendorInvoiceAmount

vendorPaymentTermsCode

protected String vendorPaymentTermsCode

vendorShippingPaymentTermsCode

protected String vendorShippingPaymentTermsCode

invoicePayDate

protected Date invoicePayDate

invoiceCostSourceCode

protected String invoiceCostSourceCode

invoiceCancelIndicator

protected boolean invoiceCancelIndicator

paymentAttachmentIndicator

protected boolean paymentAttachmentIndicator

immediatePaymentIndicator

protected boolean immediatePaymentIndicator

specialHandlingInstructionLine1Text

protected String specialHandlingInstructionLine1Text

specialHandlingInstructionLine2Text

protected String specialHandlingInstructionLine2Text

specialHandlingInstructionLine3Text

protected String specialHandlingInstructionLine3Text

paymentPaidTimestamp

protected Timestamp paymentPaidTimestamp

invoiceElectronicInvoiceIndicator

protected boolean invoiceElectronicInvoiceIndicator

accountsPayableRequestCancelIdentifier

protected String accountsPayableRequestCancelIdentifier

originalVendorHeaderGeneratedIdentifier

protected Integer originalVendorHeaderGeneratedIdentifier

originalVendorDetailAssignedIdentifier

protected Integer originalVendorDetailAssignedIdentifier

alternateVendorHeaderGeneratedIdentifier

protected Integer alternateVendorHeaderGeneratedIdentifier

alternateVendorDetailAssignedIdentifier

protected Integer alternateVendorDetailAssignedIdentifier

purchaseOrderNotes

protected String purchaseOrderNotes

recurringPaymentTypeCode

protected String recurringPaymentTypeCode

receivingDocumentRequiredIndicator

protected boolean receivingDocumentRequiredIndicator

invoicePositiveApprovalIndicator

protected boolean invoicePositiveApprovalIndicator

taxClassificationCode

protected String taxClassificationCode

taxCountryCode

protected String taxCountryCode

taxNQIId

protected String taxNQIId

taxFederalPercent

protected BigDecimal taxFederalPercent

taxStatePercent

protected BigDecimal taxStatePercent

taxSpecialW4Amount

protected org.kuali.rice.core.api.util.type.KualiDecimal taxSpecialW4Amount

taxGrossUpIndicator

protected Boolean taxGrossUpIndicator

taxExemptTreatyIndicator

protected Boolean taxExemptTreatyIndicator

taxForeignSourceIndicator

protected Boolean taxForeignSourceIndicator

taxUSAIDPerDiemIndicator

protected Boolean taxUSAIDPerDiemIndicator

taxOtherExemptIndicator

protected Boolean taxOtherExemptIndicator

vendorShippingTitleCode

protected String vendorShippingTitleCode

purchaseOrderEndDate

protected Date purchaseOrderEndDate

primaryVendorName

protected String primaryVendorName

requisitionIdentifier

protected Integer requisitionIdentifier

vendorPaymentTerms

protected PaymentTermType vendorPaymentTerms

vendorShippingPaymentTerms

protected ShippingPaymentTerms vendorShippingPaymentTerms

invoiceCostSource

protected PurchaseOrderCostSource invoiceCostSource

recurringPaymentType

protected RecurringPaymentType recurringPaymentType

Constructor Detail

InvoiceDocument

public InvoiceDocument()

Default constructor.

Method Detail

getPurchaseOrderDocuments

public List<OlePurchaseOrderDocument> getPurchaseOrderDocuments()

setPurchaseOrderDocuments

public void setPurchaseOrderDocuments(List<OlePurchaseOrderDocument> purchaseOrderDocuments)

isBoNotesSupport

public boolean isBoNotesSupport()

See Also:

org.kuali.rice.krad.bo.PersistableBusinessObjectBase#isBoNotesSupport()

getPostingYearPriorOrCurrent

public Integer getPostingYearPriorOrCurrent()

isInquiryRendered

public boolean isInquiryRendered()

Overrides the method in PurchasingAccountsPayableDocumentBase to add the criteria specific to Payment Request Document.

Specified by:

isInquiryRendered in interface PurchasingAccountsPayableDocument

Overrides:

isInquiryRendered in class PurchasingAccountsPayableDocumentBase

Returns:

See Also:

PurchasingAccountsPayableDocumentBase.isInquiryRendered()

getRequisitionIdentifier

public Integer getRequisitionIdentifier()

setRequisitionIdentifier

public void setRequisitionIdentifier(Integer requisitionIdentifier)

isEnableReceivingDocumentRequiredIndicator

public boolean isEnableReceivingDocumentRequiredIndicator()

Decides whether receivingDocumentRequiredIndicator functionality shall be enabled according to the controlling parameter.

isEnableInvoicePositiveApprovalIndicator

public boolean isEnableInvoicePositiveApprovalIndicator()

Decides whether invoicePositiveApprovalIndicator functionality shall be enabled according to the controlling parameter.

getInvoiceDate

public Date getInvoiceDate()

setInvoiceDate

public void setInvoiceDate(Date invoiceDate)

getInvoiceNumber

public String getInvoiceNumber()

setInvoiceNumber

public void setInvoiceNumber(String invoiceNumber)

getVendorInvoiceAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getVendorInvoiceAmount()

setVendorInvoiceAmount

public void setVendorInvoiceAmount(org.kuali.rice.core.api.util.type.KualiDecimal vendorInvoiceAmount)

getVendorPaymentTermsCode

public String getVendorPaymentTermsCode()

setVendorPaymentTermsCode

public void setVendorPaymentTermsCode(String vendorPaymentTermsCode)

getVendorPaymentTerms

public PaymentTermType getVendorPaymentTerms()

setVendorPaymentTerms

public void setVendorPaymentTerms(PaymentTermType vendorPaymentTerms)

getVendorShippingPaymentTermsCode

public String getVendorShippingPaymentTermsCode()

setVendorShippingPaymentTermsCode

public void setVendorShippingPaymentTermsCode(String vendorShippingPaymentTermsCode)

getInvoicePayDate

public Date getInvoicePayDate()

setInvoicePayDate

public void setInvoicePayDate(Date invoicePayDate)

getInvoiceCostSourceCode

public String getInvoiceCostSourceCode()

setInvoiceCostSourceCode

public void setInvoiceCostSourceCode(String invoiceCostSourceCode)

getInvoiceCancelIndicator

public boolean getInvoiceCancelIndicator()

isInvoiceCancelIndicator

public boolean isInvoiceCancelIndicator()

setInvoiceCancelIndicator

public void setInvoiceCancelIndicator(boolean invoiceCancelIndicator)

getPaymentAttachmentIndicator

public boolean getPaymentAttachmentIndicator()

setPaymentAttachmentIndicator

public void setPaymentAttachmentIndicator(boolean paymentAttachmentIndicator)

getImmediatePaymentIndicator

public boolean getImmediatePaymentIndicator()

setImmediatePaymentIndicator

public void setImmediatePaymentIndicator(boolean immediatePaymentIndicator)

getSpecialHandlingInstructionLine1Text

public String getSpecialHandlingInstructionLine1Text()

setSpecialHandlingInstructionLine1Text

public void setSpecialHandlingInstructionLine1Text(String specialHandlingInstructionLine1Text)

getSpecialHandlingInstructionLine2Text

public String getSpecialHandlingInstructionLine2Text()

setSpecialHandlingInstructionLine2Text

public void setSpecialHandlingInstructionLine2Text(String specialHandlingInstructionLine2Text)

getSpecialHandlingInstructionLine3Text

public String getSpecialHandlingInstructionLine3Text()

setSpecialHandlingInstructionLine3Text

public void setSpecialHandlingInstructionLine3Text(String specialHandlingInstructionLine3Text)

getPaymentPaidTimestamp

public Timestamp getPaymentPaidTimestamp()

setPaymentPaidTimestamp

public void setPaymentPaidTimestamp(Timestamp paymentPaidTimestamp)

getInvoiceElectronicInvoiceIndicator

public boolean getInvoiceElectronicInvoiceIndicator()

setInvoiceElectronicInvoiceIndicator

public void setInvoiceElectronicInvoiceIndicator(boolean invoiceElectronicInvoiceIndicator)

getAccountsPayableRequestCancelIdentifier

public String getAccountsPayableRequestCancelIdentifier()

setAccountsPayableRequestCancelIdentifier

public void setAccountsPayableRequestCancelIdentifier(String accountsPayableRequestCancelIdentifier)

getOriginalVendorHeaderGeneratedIdentifier

public Integer getOriginalVendorHeaderGeneratedIdentifier()

setOriginalVendorHeaderGeneratedIdentifier

public void setOriginalVendorHeaderGeneratedIdentifier(Integer originalVendorHeaderGeneratedIdentifier)

getOriginalVendorDetailAssignedIdentifier

public Integer getOriginalVendorDetailAssignedIdentifier()

setOriginalVendorDetailAssignedIdentifier

public void setOriginalVendorDetailAssignedIdentifier(Integer originalVendorDetailAssignedIdentifier)

getAlternateVendorHeaderGeneratedIdentifier

public Integer getAlternateVendorHeaderGeneratedIdentifier()

setAlternateVendorHeaderGeneratedIdentifier

public void setAlternateVendorHeaderGeneratedIdentifier(Integer alternateVendorHeaderGeneratedIdentifier)

getAlternateVendorDetailAssignedIdentifier

public Integer getAlternateVendorDetailAssignedIdentifier()

setAlternateVendorDetailAssignedIdentifier

public void setAlternateVendorDetailAssignedIdentifier(Integer alternateVendorDetailAssignedIdentifier)

getVendorShippingPaymentTerms

public ShippingPaymentTerms getVendorShippingPaymentTerms()

setVendorShippingPaymentTerms

public void setVendorShippingPaymentTerms(ShippingPaymentTerms vendorShippingPaymentTerms)

getVendorShippingTitleCode

public String getVendorShippingTitleCode()

setVendorShippingTitleCode

public void setVendorShippingTitleCode(String vendorShippingTitleCode)

getPurchaseOrderEndDate

public Date getPurchaseOrderEndDate()

setPurchaseOrderEndDate

public void setPurchaseOrderEndDate(Date purchaseOrderEndDate)

isInvoicePositiveApprovalIndicator

public boolean isInvoicePositiveApprovalIndicator()

Gets the invoicePositiveApprovalIndicator attribute.

Returns:

Returns the invoicePositiveApprovalIndicator.

setInvoicePositiveApprovalIndicator

public void setInvoicePositiveApprovalIndicator(boolean invoicePositiveApprovalIndicator)

Sets the invoicePositiveApprovalIndicator attribute value.

Parameters:

invoicePositiveApprovalIndicator - The invoicePositiveApprovalIndicator to set.

isReceivingDocumentRequiredIndicator

public boolean isReceivingDocumentRequiredIndicator()

Gets the receivingDocumentRequiredIndicator attribute.

Returns:

Returns the receivingDocumentRequiredIndicator.

setReceivingDocumentRequiredIndicator

public void setReceivingDocumentRequiredIndicator(boolean receivingDocumentRequiredIndicator)

Sets the receivingDocumentRequiredIndicator attribute value.

Parameters:

receivingDocumentRequiredIndicator - The receivingDocumentRequiredIndicator to set.

initiateDocument

public void initiateDocument()
                      throws org.kuali.rice.kew.api.exception.WorkflowException

Perform logic needed to initiate PRQS Document

Throws:

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

clearInitFields

public void clearInitFields()

Perform logic needed to clear the initial fields on a PRQS Document

populateInvoiceFromPurchaseOrder

public void populateInvoiceFromPurchaseOrder(PurchaseOrderDocument po)

Populates a preq from a PO - delegate method

Parameters:

po - -

populateInvoiceFromPurchaseOrder

public void populateInvoiceFromPurchaseOrder(PurchaseOrderDocument po,
                                    HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Populates a preq from a PO

Parameters:

po - Purchase Order Document used for populating the PRQS

expiredOrClosedAccountList - a list of closed or expired accounts

getDocumentTitle

public String getDocumentTitle()

Specified by:

getDocumentTitle in interface org.kuali.rice.krad.document.Document

Overrides:

getDocumentTitle in class org.kuali.rice.krad.document.DocumentBase

See Also:

DocumentBase.getDocumentTitle()

getCustomDocumentTitle

protected String getCustomDocumentTitle()

Returns a custom document title based on the workflow document title. Depending on what route level the document is currently in, the PO, vendor, amount, account number, dept, campus may be added to the documents title.

Returns:

- Customized document title text dependent upon route level.

getFirstAccount

public PurApAccountingLine getFirstAccount()

Returns the first payment item's first account (assuming the item list is sequentially ordered).

Returns:

- Accounting Line object for first account of first payment item.

getTitleIndicator

protected String getTitleIndicator()

Determines the indicator text that will appear in the workflow document title

Returns:

- Text of hold or request cancel

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

Description copied from class: GeneralLedgerPostingDocumentBase

Override to call super and then iterate over all GLPEs and update the approved code appropriately.

Specified by:

doRouteStatusChange in interface org.kuali.rice.krad.document.Document

Overrides:

doRouteStatusChange in class GeneralLedgerPostingDocumentBase

See Also:

DocumentBase.doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange)

doActionTaken

public void doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)

Generates correcting entries to the GL if accounts are modified.

Specified by:

doActionTaken in interface org.kuali.rice.krad.document.Document

Overrides:

doActionTaken in class org.kuali.rice.krad.document.DocumentBase

See Also:

Document.doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent)

processNodeChange

public boolean processNodeChange(String newNodeName,
                        String oldNodeName)

Description copied from class: AccountsPayableDocumentBase

Hook to allow processing after a route level is passed.

Specified by:

processNodeChange in class AccountsPayableDocumentBase

Parameters:

newNodeName - - current route level

oldNodeName - - previous route level

Returns:

- true if process completes to valid state

See Also:

AccountsPayableDocumentBase.processNodeChange(String, String)

saveDocumentFromPostProcessing

public void saveDocumentFromPostProcessing()

Description copied from class: AccountsPayableDocumentBase

Hook point to allow processing after a save.

Specified by:

saveDocumentFromPostProcessing in class AccountsPayableDocumentBase

See Also:

AccountsPayableDocumentBase.saveDocumentFromPostProcessing()

getItemClass

public Class getItemClass()

Description copied from interface: PurchasingAccountsPayableDocument

Returns the Item Class.

Specified by:

getItemClass in interface PurapItemOperations

Specified by:

getItemClass in interface PurchasingAccountsPayableDocument

Overrides:

getItemClass in class AccountsPayableDocumentBase

Returns:

the Item Class.

See Also:

PurchasingAccountsPayableDocumentBase.getItemClass()

getItemUseTaxClass

public Class getItemUseTaxClass()

Specified by:

getItemUseTaxClass in class PurchasingAccountsPayableDocumentBase

getPurApSourceDocumentIfPossible

public PurchaseOrderDocument getPurApSourceDocumentIfPossible()

Description copied from interface: PurchasingAccountsPayableDocument

Returns the source of this Purchasing Accounts Payable Document if exists.

Specified by:

getPurApSourceDocumentIfPossible in interface PurchasingAccountsPayableDocument

Overrides:

getPurApSourceDocumentIfPossible in class AccountsPayableDocumentBase

Returns:

the source of this document if exists, else null.

See Also:

PurchasingAccountsPayableDocumentBase.getPurApSourceDocumentIfPossible()

getPurApSourceDocumentLabelIfPossible

public String getPurApSourceDocumentLabelIfPossible()

Description copied from interface: PurchasingAccountsPayableDocument

Returns the label of the source of this Purchasing Accounts Payable Document if exists.

Specified by:

getPurApSourceDocumentLabelIfPossible in interface PurchasingAccountsPayableDocument

Overrides:

getPurApSourceDocumentLabelIfPossible in class AccountsPayableDocumentBase

Returns:

the label of the document source if exists, else null.

See Also:

PurchasingAccountsPayableDocumentBase.getPurApSourceDocumentLabelIfPossible()

getPurchaseOrderNotes

public String getPurchaseOrderNotes()

setPurchaseOrderNotes

public void setPurchaseOrderNotes(String purchaseOrderNotes)

getRecurringPaymentTypeCode

public String getRecurringPaymentTypeCode()

setRecurringPaymentTypeCode

public void setRecurringPaymentTypeCode(String recurringPaymentTypeCode)

getItemTotalPoEncumbranceAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getItemTotalPoEncumbranceAmount()

Returns the total encumbered amount from the purchase order excluding below the line.

Returns:

Total cost excluding below the line

getItemTotalPoEncumbranceAmountRelieved

public org.kuali.rice.core.api.util.type.KualiDecimal getItemTotalPoEncumbranceAmountRelieved()

getItemTotalPoEncumbranceAmountRelieved

public org.kuali.rice.core.api.util.type.KualiDecimal getItemTotalPoEncumbranceAmountRelieved(boolean includeBelowTheLine)

getLineItemTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getLineItemTotal()

getLineItemPreTaxTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getLineItemPreTaxTotal()

getLineItemTaxAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getLineItemTaxAmount()

getGrandTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getGrandTotal()

Description copied from interface: AccountsPayableDocument

Retrieves grand total amount for document.

Specified by:

getGrandTotal in interface AccountsPayableDocument

Specified by:

getGrandTotal in class AccountsPayableDocumentBase

Returns:

- grand total

See Also:

AccountsPayableDocument.getGrandTotal()

getGrandTotalExcludingDiscount

public org.kuali.rice.core.api.util.type.KualiDecimal getGrandTotalExcludingDiscount()

setGrandTotalExcludingDiscount

public void setGrandTotalExcludingDiscount(org.kuali.rice.core.api.util.type.KualiDecimal amount)

This method is here due to a setter requirement by the htmlControlAttribute

Parameters:

amount - - Grand total for document, excluding discount

getGrandPreTaxTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getGrandPreTaxTotal()

getGrandPreTaxTotalExcludingDiscount

public org.kuali.rice.core.api.util.type.KualiDecimal getGrandPreTaxTotalExcludingDiscount()

getGrandTaxAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getGrandTaxAmount()

getGrandTaxAmountExcludingDiscount

public org.kuali.rice.core.api.util.type.KualiDecimal getGrandTaxAmountExcludingDiscount()

isDiscount

public boolean isDiscount()

getItemTotalPoPaidAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getItemTotalPoPaidAmount()

The total that was paid on the po excluding below the line

Returns:

total paid

getAccountsPayableRequestCancelPersonName

public String getAccountsPayableRequestCancelPersonName()

Returns the name of who requested cancel.

Returns:

- name of who requested cancel.

setItemTotalPoPaidAmount

public void setItemTotalPoPaidAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount)

Exists due to a setter requirement by the htmlControlAttribute

Parameters:

amount - - total po amount paid

setItemTotalPoEncumbranceAmount

public void setItemTotalPoEncumbranceAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount)

Exists due to a setter requirement by the htmlControlAttribute

Parameters:

amount - - total po encumbrance

setItemTotalPoEncumbranceAmountRelieved

public void setItemTotalPoEncumbranceAmountRelieved(org.kuali.rice.core.api.util.type.KualiDecimal amount)

Exists due to a setter requirement by the htmlControlAttribute

Parameters:

amount - - total po encumbrance amount relieved

getCurrentRouteLevels

protected List<String> getCurrentRouteLevels(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)

Determinines the route levels for a given document.

Parameters:

workflowDocument - - work flow document

Returns:

List - list of route levels

getRecurringPaymentType

public RecurringPaymentType getRecurringPaymentType()

setRecurringPaymentType

public void setRecurringPaymentType(RecurringPaymentType recurringPaymentType)

getInvoiceCostSource

public PurchaseOrderCostSource getInvoiceCostSource()

setInvoiceCostSource

public void setInvoiceCostSource(PurchaseOrderCostSource invoiceCostSource)

getPoDocumentTypeForAccountsPayableDocumentCancel

public String getPoDocumentTypeForAccountsPayableDocumentCancel()

Description copied from class: AccountsPayableDocumentBase

Helper method to be called from custom prepare for save and to be overriden by sub class.

Specified by:

getPoDocumentTypeForAccountsPayableDocumentCancel in class AccountsPayableDocumentBase

Returns:

- Po Document Type

See Also:

AccountsPayableDocumentBase.getPoDocumentTypeForAccountsPayableDocumentCancel()

getInitialAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getInitialAmount()

Description copied from interface: AccountsPayableDocument

Returns the amount entered on the initial screen.

Specified by:

getInitialAmount in interface AccountsPayableDocument

Specified by:

getInitialAmount in class AccountsPayableDocumentBase

Returns:

- amount entered by user on initial screen

See Also:

AccountsPayableDocumentBase.getInitialAmount()

prepareForSave

public void prepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Populates the payment request document, then continues with preparing for save.

Specified by:

prepareForSave in interface org.kuali.rice.krad.document.Document

Overrides:

prepareForSave in class AccountsPayableDocumentBase

See Also:

Document.prepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent)

isAttachmentRequired

protected boolean isAttachmentRequired()

Description copied from class: AccountsPayableDocumentBase

Checks whether an attachment is required

Specified by:

isAttachmentRequired in class AccountsPayableDocumentBase

Returns:

- true if attachment is required, otherwise false

See Also:

AccountsPayableDocumentBase.isAttachmentRequired()

getDocumentSpecificService

public AccountsPayableDocumentSpecificService getDocumentSpecificService()

Specified by:

getDocumentSpecificService in interface AccountsPayableDocument

Specified by:

getDocumentSpecificService in class AccountsPayableDocumentBase

See Also:

AccountsPayableDocument.getDocumentSpecificService()

getItem

public PurApItem getItem(int pos)

Description copied from interface: PurchasingAccountsPayableDocument

Gets the item at the specified index.

Specified by:

getItem in interface PurapItemOperations

Specified by:

getItem in interface PurchasingAccountsPayableDocument

Overrides:

getItem in class PurchasingAccountsPayableDocumentBase

Parameters:

pos - the specified index.

Returns:

the item at the specified index.

See Also:

PurchasingAccountsPayableDocumentBase.getItem(int)

getPrimaryVendorName

public String getPrimaryVendorName()

setPrimaryVendorName

@Deprecated
public void setPrimaryVendorName(String primaryVendorName)

Deprecated.

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable,
                                              GeneralLedgerPendingEntry explicitEntry)

Forces general ledger entries to be approved, does not wait for payment request document final approval.

Overrides:

customizeExplicitGeneralLedgerPendingEntry in class AccountingDocumentBase

See Also:

org.kuali.module.purap.rules.PurapAccountingDocumentRuleBase#customizeExplicitGeneralLedgerPendingEntry(org.kuali.ole.sys.document.AccountingDocument, org.kuali.ole.sys.businessobject.AccountingLine, org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntry)

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Provides answers to the following splits: PurchaseWasReceived VendorIsEmployeeOrNonResidentAlien

Specified by:

answerSplitNodeQuestion in interface FinancialSystemDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(String)

isVendorEmployeeOrNonResidentAlien

protected boolean isVendorEmployeeOrNonResidentAlien()

shouldWaitForReceiving

protected boolean shouldWaitForReceiving()

Payment Request needs to wait for receiving if the receiving requirements have NOT been met.

Returns:

isReceivingRequirementMet

public boolean isReceivingRequirementMet()

Determine if the receiving requirement has been met for all items on the payment request. If any item does not have receiving requirements met, return false. Receiving requirement has NOT been met if the quantity invoiced on the Payment Request is greater than the quantity of "unpaid and received" items determined by (poQtyReceived - (poQtyInvoiced)).

Returns:

boolean return true if the receiving requirement has been met for all items on the payment request; false if requirement has not been met

getTransactionTaxDate

public Date getTransactionTaxDate()

getTaxClassificationCode

public String getTaxClassificationCode()

setTaxClassificationCode

public void setTaxClassificationCode(String taxClassificationCode)

getTaxFederalPercentShort

public org.kuali.rice.core.api.util.type.KualiDecimal getTaxFederalPercentShort()

getTaxFederalPercent

public BigDecimal getTaxFederalPercent()

setTaxFederalPercent

public void setTaxFederalPercent(BigDecimal taxFederalPercent)

getTaxStatePercentShort

public org.kuali.rice.core.api.util.type.KualiDecimal getTaxStatePercentShort()

getTaxStatePercent

public BigDecimal getTaxStatePercent()

setTaxStatePercent

public void setTaxStatePercent(BigDecimal taxStatePercent)

getTaxCountryCode

public String getTaxCountryCode()

setTaxCountryCode

public void setTaxCountryCode(String taxCountryCode)

getTaxGrossUpIndicator

public Boolean getTaxGrossUpIndicator()

setTaxGrossUpIndicator

public void setTaxGrossUpIndicator(Boolean taxGrossUpIndicator)

getTaxExemptTreatyIndicator

public Boolean getTaxExemptTreatyIndicator()

setTaxExemptTreatyIndicator

public void setTaxExemptTreatyIndicator(Boolean taxExemptTreatyIndicator)

getTaxForeignSourceIndicator

public Boolean getTaxForeignSourceIndicator()

setTaxForeignSourceIndicator

public void setTaxForeignSourceIndicator(Boolean taxForeignSourceIndicator)

getTaxSpecialW4Amount

public org.kuali.rice.core.api.util.type.KualiDecimal getTaxSpecialW4Amount()

setTaxSpecialW4Amount

public void setTaxSpecialW4Amount(org.kuali.rice.core.api.util.type.KualiDecimal taxSpecialW4Amount)

getTaxUSAIDPerDiemIndicator

public Boolean getTaxUSAIDPerDiemIndicator()

setTaxUSAIDPerDiemIndicator

public void setTaxUSAIDPerDiemIndicator(Boolean taxUSAIDPerDiemIndicator)

getTaxOtherExemptIndicator

public Boolean getTaxOtherExemptIndicator()

setTaxOtherExemptIndicator

public void setTaxOtherExemptIndicator(Boolean taxOtherExemptIndicator)

getTaxNQIId

public String getTaxNQIId()

setTaxNQIId

public void setTaxNQIId(String taxNQIId)

isInvoiceCancelIndicatorForSearching

public boolean isInvoiceCancelIndicatorForSearching()

getInvoicePositiveApprovalIndicatorForSearching

public boolean getInvoicePositiveApprovalIndicatorForSearching()

Returns:

the payment request positive approval indicator

getReceivingDocumentRequiredIndicatorForSearching

public boolean getReceivingDocumentRequiredIndicatorForSearching()

Returns:

the receiving document required indicator

getRequestCancelIndicatorForResult

public String getRequestCancelIndicatorForResult()

getPaidIndicatorForResult

public String getPaidIndicatorForResult()

getAccountsPayableApprovalDateForSearching

public Date getAccountsPayableApprovalDateForSearching()

documentHasNoImagesAttached

public boolean documentHasNoImagesAttached()

Checks all documents notes for attachments.

Specified by:

documentHasNoImagesAttached in class AccountsPayableDocumentBase

Returns:

- true if document does not have an image attached, false otherwise

closePurchaseOrder

protected void closePurchaseOrder()

getPurchaseOrderDocument

public PurchaseOrderDocument getPurchaseOrderDocument()

Specified by:

getPurchaseOrderDocument in interface AccountsPayableDocument

Overrides:

getPurchaseOrderDocument in class AccountsPayableDocumentBase

See Also:

AccountsPayableDocument.getPurchaseOrderDocument()

getPurchaseOrderDocument

public PurchaseOrderDocument getPurchaseOrderDocument(Integer poID)

See Also:

AccountsPayableDocument.getPurchaseOrderDocument()