org.kuali.kfs.module.purap.document
Class PaymentRequestDocument

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.document.DocumentBase
              org.kuali.rice.kns.document.TransactionalDocumentBase
                  org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      org.kuali.kfs.sys.document.LedgerPostingDocumentBase
                          org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase
                              org.kuali.kfs.sys.document.AccountingDocumentBase
                                  org.kuali.kfs.module.purap.document.PurchasingAccountsPayableDocumentBase
                                      org.kuali.kfs.module.purap.document.AccountsPayableDocumentBase
                                          org.kuali.kfs.module.purap.document.PaymentRequestDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, AccountsPayableDocument, PurapItemOperations, PurchasingAccountsPayableDocument, AccountingDocument, AmountTotaling, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument

public class PaymentRequestDocument
extends AccountsPayableDocumentBase

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

See Also:

Serialized Form

Field Summary

protected String	accountsPayableRequestCancelIdentifier
protected Integer	alternateVendorDetailAssignedIdentifier
protected Integer	alternateVendorHeaderGeneratedIdentifier
protected boolean	immediatePaymentIndicator
protected Date	invoiceDate
protected String	invoiceNumber
protected static org.apache.log4j.Logger	LOG
protected Integer	originalVendorDetailAssignedIdentifier
protected Integer	originalVendorHeaderGeneratedIdentifier
protected boolean	paymentAttachmentIndicator
protected Timestamp	paymentPaidTimestamp
protected PurchaseOrderCostSource	paymentRequestCostSource
protected String	paymentRequestCostSourceCode
protected boolean	paymentRequestedCancelIndicator
protected boolean	paymentRequestElectronicInvoiceIndicator
protected Date	paymentRequestPayDate
protected boolean	paymentRequestPositiveApprovalIndicator
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.kns.util.KualiDecimal	taxSpecialW4Amount
protected BigDecimal	taxStatePercent
protected Boolean	taxUSAIDPerDiemIndicator
protected org.kuali.rice.kns.util.KualiDecimal	vendorInvoiceAmount
protected PaymentTermType	vendorPaymentTerms
protected String	vendorPaymentTermsCode
protected ShippingPaymentTerms	vendorShippingPaymentTerms
protected String	vendorShippingPaymentTermsCode
protected String	vendorShippingTitleCode

Fields inherited from class org.kuali.kfs.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.kfs.module.purap.document.PurchasingAccountsPayableDocumentBase

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

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

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

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

generalLedgerPendingEntries

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

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

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

documentHeader

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

documentBusinessObject, documentNumber

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

extension, versionNumber

Constructor Summary

PaymentRequestDocument()
Default constructor.

Method Summary

boolean	answerSplitNodeQuestion(String nodeName) Provides answers to the following splits: PurchaseWasReceived VendorIsEmployeeOrNonResidentAlien
void	clearInitFields() Perform logic needed to clear the initial fields on a PREQ Document
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.dto.ActionTakenEventDTO 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.dto.DocumentRouteStatusChangeDTO 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	getCurrentRouteLevels(org.kuali.rice.kns.workflow.service.KualiWorkflowDocument 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.kns.util.KualiDecimal	getGrandPreTaxTotal()
org.kuali.rice.kns.util.KualiDecimal	getGrandPreTaxTotalExcludingDiscount()
org.kuali.rice.kns.util.KualiDecimal	getGrandTaxAmount()
org.kuali.rice.kns.util.KualiDecimal	getGrandTaxAmountExcludingDiscount()
org.kuali.rice.kns.util.KualiDecimal	getGrandTotal() Retrieves grand total amount for document.
org.kuali.rice.kns.util.KualiDecimal	getGrandTotalExcludingDiscount()
boolean	getImmediatePaymentIndicator()
org.kuali.rice.kns.util.KualiDecimal	getInitialAmount() Returns the amount entered on the initial screen.
Date	getInvoiceDate()
String	getInvoiceNumber()
PurApItem	getItem(int pos) Gets the item at the specified index.
Class	getItemClass() Returns the Item Class.
org.kuali.rice.kns.util.KualiDecimal	getItemTotalPoEncumbranceAmount() Returns the total encumbered amount from the purchase order excluding below the line.
org.kuali.rice.kns.util.KualiDecimal	getItemTotalPoEncumbranceAmountRelieved()
org.kuali.rice.kns.util.KualiDecimal	getItemTotalPoEncumbranceAmountRelieved(boolean includeBelowTheLine)
org.kuali.rice.kns.util.KualiDecimal	getItemTotalPoPaidAmount() The total that was paid on the po excluding below the line
Class	getItemUseTaxClass()
org.kuali.rice.kns.util.KualiDecimal	getLineItemPreTaxTotal()
org.kuali.rice.kns.util.KualiDecimal	getLineItemTaxAmount()
org.kuali.rice.kns.util.KualiDecimal	getLineItemTotal()
PurapWorkflowConstants.NodeDetails	getNodeDetailEnum(String nodeName) Retrieves node details object based on name.
Integer	getOriginalVendorDetailAssignedIdentifier()
Integer	getOriginalVendorHeaderGeneratedIdentifier()
String	getPaidIndicatorForResult()
boolean	getPaymentAttachmentIndicator()
Timestamp	getPaymentPaidTimestamp()
PurchaseOrderCostSource	getPaymentRequestCostSource()
String	getPaymentRequestCostSourceCode()
boolean	getPaymentRequestedCancelIndicator()
boolean	getPaymentRequestElectronicInvoiceIndicator()
Date	getPaymentRequestPayDate()
boolean	getPaymentRequestPositiveApprovalIndicatorForSearching()
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.
Date	getPurchaseOrderEndDate()
String	getPurchaseOrderNotes()
boolean	getReceivingDocumentRequiredIndicatorForSearching()
RecurringPaymentType	getRecurringPaymentType()
String	getRecurringPaymentTypeCode()
String	getRequestCancelIndicatorForResult()
Integer	getRequisitionIdentifier()
String	getSpecialHandlingInstructionLine1Text()
String	getSpecialHandlingInstructionLine2Text()
String	getSpecialHandlingInstructionLine3Text()
String	getStatusDescription() Deprecated.
String	getTaxClassificationCode()
String	getTaxCountryCode()
Boolean	getTaxExemptTreatyIndicator()
BigDecimal	getTaxFederalPercent()
org.kuali.rice.kns.util.KualiDecimal	getTaxFederalPercentShort()
Boolean	getTaxForeignSourceIndicator()
Boolean	getTaxGrossUpIndicator()
String	getTaxNQIId()
Boolean	getTaxOtherExemptIndicator()
org.kuali.rice.kns.util.KualiDecimal	getTaxSpecialW4Amount()
BigDecimal	getTaxStatePercent()
org.kuali.rice.kns.util.KualiDecimal	getTaxStatePercentShort()
Boolean	getTaxUSAIDPerDiemIndicator()
protected String	getTitleIndicator() Determines the indicator text that will appear in the workflow document title
Date	getTransactionTaxDate()
org.kuali.rice.kns.util.KualiDecimal	getVendorInvoiceAmount()
PaymentTermType	getVendorPaymentTerms()
String	getVendorPaymentTermsCode()
ShippingPaymentTerms	getVendorShippingPaymentTerms()
String	getVendorShippingPaymentTermsCode()
String	getVendorShippingTitleCode()
void	initiateDocument() Perform logic needed to initiate PREQ Document
protected boolean	isAttachmentRequired() Checks whether an attachment is required
boolean	isBoNotesSupport()
boolean	isDiscount()
boolean	isInquiryRendered() Overrides the method in PurchasingAccountsPayableDocumentBase to add the criteria specific to Payment Request Document.
boolean	isPaymentRequestedCancelIndicator()
boolean	isPaymentRequestedCancelIndicatorForSearching()
boolean	isPaymentRequestPositiveApprovalIndicator() Gets the paymentRequestPositiveApprovalIndicator 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	populateDocumentForRouting()
void	populatePaymentRequestFromPurchaseOrder(PurchaseOrderDocument po) Populates a preq from a PO - delegate method
void	populatePaymentRequestFromPurchaseOrder(PurchaseOrderDocument po, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Populates a preq from a PO
void	prepareForSave(org.kuali.rice.kns.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.kns.util.KualiDecimal amount) This method is here due to a setter requirement by the htmlControlAttribute
void	setImmediatePaymentIndicator(boolean immediatePaymentIndicator)
void	setInvoiceDate(Date invoiceDate)
void	setInvoiceNumber(String invoiceNumber)
void	setItemTotalPoEncumbranceAmount(org.kuali.rice.kns.util.KualiDecimal amount) Exists due to a setter requirement by the htmlControlAttribute
void	setItemTotalPoEncumbranceAmountRelieved(org.kuali.rice.kns.util.KualiDecimal amount) Exists due to a setter requirement by the htmlControlAttribute
void	setItemTotalPoPaidAmount(org.kuali.rice.kns.util.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	setPaymentRequestCostSource(PurchaseOrderCostSource paymentRequestCostSource)
void	setPaymentRequestCostSourceCode(String paymentRequestCostSourceCode)
void	setPaymentRequestedCancelIndicator(boolean paymentRequestedCancelIndicator)
void	setPaymentRequestElectronicInvoiceIndicator(boolean paymentRequestElectronicInvoiceIndicator)
void	setPaymentRequestPayDate(Date paymentRequestPayDate)
void	setPaymentRequestPositiveApprovalIndicator(boolean paymentRequestPositiveApprovalIndicator) Sets the paymentRequestPositiveApprovalIndicator attribute value.
void	setPrimaryVendorName(String primaryVendorName) Deprecated.
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	setStatusDescription(String statusDescription) Deprecated.
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.kns.util.KualiDecimal taxSpecialW4Amount)
void	setTaxStatePercent(BigDecimal taxStatePercent)
void	setTaxUSAIDPerDiemIndicator(Boolean taxUSAIDPerDiemIndicator)
void	setVendorInvoiceAmount(org.kuali.rice.kns.util.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.kfs.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, getPurchaseOrderDocument, getPurchaseOrderIdentifier, getTotalRemitTax, isClosePurchaseOrderIndicator, isContinuationAccountIndicator, isExtracted, isGenerateEncumbranceEntries, isHoldIndicator, isHoldIndicatorForSearching, isReopenPurchaseOrderIndicator, isUnmatchedOverride, 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.kfs.module.purap.document.PurchasingAccountsPayableDocumentBase

addItem, buildDocumentTitle, buildListOfDeletionAwareLists, customPrepareForSave, deleteItem, documentPerformsSufficientFundsCheck, fixItemReferences, getAccountsForRouting, getAccountsPayablePurchasingDocumentLinkIdentifier, getBelowTheLineTypes, getDeletionAwareAccountingLines, getFirstPendingGLEntry, getIsATypeOfPODoc, getIsATypeOfPurAPRecDoc, getIsATypeOfPurDoc, getIsPODoc, getIsReqsDoc, getItemByItemIdentifier, getItemByLineNumber, getItemByStringIdentifier, getItemLinePosition, getItems, getNeedWarningRelatedPOs, getOverrideWorkflowButtons, getPersistedSourceAccountingLinesForComparison, getPostingPeriodCodeFromPendingGLEntries, getPostingYearFromPendingGLEntries, getPostingYearNextOrCurrent, getPurapDocumentIdentifier, getRelatedViews, getSourceAccountingLines, getSourceAccountingLinesForComparison, getStatus, getStatusCode, getStatusCodeForMultiboxSearching, 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, isDebit, isDocumentStoppedInRouteNode, isPostingYearNext, isPostingYearPrior, isSensitive, isUseTaxIndicator, itemSwap, logAndThrowRuntimeException, logAndThrowRuntimeException, populateAccountsForRouting, processAfterRetrieve, refreshNonUpdateableReferences, renumberItems, setAccountsForRouting, setAccountsPayablePurchasingDocumentLinkIdentifier, setItems, setOverrideWorkflowButtons, setPostingYear, setPurapDocumentIdentifier, setRelatedViews, setStatus, setStatusCode, setTotalDollarAmount, setTotalPreTaxDollarAmount, setTotalTaxAmount, setUseTaxIndicator, setVendorAddressGeneratedIdentifier, setVendorAddressInternationalProvinceName, setVendorAttentionName, setVendorCityName, setVendorCountry, setVendorCountryCode, setVendorCustomerNumber, setVendorDetail, setVendorDetailAssignedIdentifier, setVendorHeaderGeneratedIdentifier, setVendorLine1Address, setVendorLine2Address, setVendorName, setVendorNumber, setVendorPostalCode, setVendorStateCode, templateVendorAddress, toStringMapper

Methods inherited from class org.kuali.kfs.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, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, toErrorCorrection, updatePostingYearForAccountingLines

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

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

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

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

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

getDocumentHeader, prepareForSave, setDocumentHeader

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

getAllowsCopy, isSessionDocument

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

addCopyErrorDocumentNote, addPessimisticLock, afterLookup, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setPessimisticLocks, toString, toStringBuilder, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

addNote, afterDelete, afterInsert, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isNewCollectionRecord, linkEditableUserFields, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

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

prepareForWorkflow

Methods inherited from class java.lang.Object

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

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

addItem, deleteItem, fixItemReferences, getAccountsPayablePurchasingDocumentLinkIdentifier, getBelowTheLineTypes, getIsATypeOfPODoc, getIsATypeOfPurAPRecDoc, getIsATypeOfPurDoc, getIsPODoc, getIsReqsDoc, getItemLinePosition, getItems, getPostingYearNextOrCurrent, getPurapDocumentIdentifier, getStatus, getStatusCode, 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, isDocumentStoppedInRouteNode, 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, 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

getDocumentHeader

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

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, postProcessSave, 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, 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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

invoiceDate

protected Date invoiceDate

invoiceNumber

protected String invoiceNumber

vendorInvoiceAmount

protected org.kuali.rice.kns.util.KualiDecimal vendorInvoiceAmount

vendorPaymentTermsCode

protected String vendorPaymentTermsCode

vendorShippingPaymentTermsCode

protected String vendorShippingPaymentTermsCode

paymentRequestPayDate

protected Date paymentRequestPayDate

paymentRequestCostSourceCode

protected String paymentRequestCostSourceCode

paymentRequestedCancelIndicator

protected boolean paymentRequestedCancelIndicator

paymentAttachmentIndicator

protected boolean paymentAttachmentIndicator

immediatePaymentIndicator

protected boolean immediatePaymentIndicator

specialHandlingInstructionLine1Text

protected String specialHandlingInstructionLine1Text

specialHandlingInstructionLine2Text

protected String specialHandlingInstructionLine2Text

specialHandlingInstructionLine3Text

protected String specialHandlingInstructionLine3Text

paymentPaidTimestamp

protected Timestamp paymentPaidTimestamp

paymentRequestElectronicInvoiceIndicator

protected boolean paymentRequestElectronicInvoiceIndicator

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

paymentRequestPositiveApprovalIndicator

protected boolean paymentRequestPositiveApprovalIndicator

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.kns.util.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

paymentRequestCostSource

protected PurchaseOrderCostSource paymentRequestCostSource

recurringPaymentType

protected RecurringPaymentType recurringPaymentType

Constructor Detail

PaymentRequestDocument

public PaymentRequestDocument()

Default constructor.

Method Detail

isBoNotesSupport

public boolean isBoNotesSupport()

Specified by:

isBoNotesSupport in interface org.kuali.rice.kns.bo.PersistableBusinessObject

Overrides:

isBoNotesSupport in class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

See Also:

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)

populateDocumentForRouting

public void populateDocumentForRouting()

Specified by:

populateDocumentForRouting in interface org.kuali.rice.kns.document.Document

Overrides:

populateDocumentForRouting in class AccountsPayableDocumentBase

See Also:

AccountsPayableDocumentBase.populateDocumentForRouting()

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.kns.util.KualiDecimal getVendorInvoiceAmount()

setVendorInvoiceAmount

public void setVendorInvoiceAmount(org.kuali.rice.kns.util.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)

getPaymentRequestPayDate

public Date getPaymentRequestPayDate()

setPaymentRequestPayDate

public void setPaymentRequestPayDate(Date paymentRequestPayDate)

getPaymentRequestCostSourceCode

public String getPaymentRequestCostSourceCode()

setPaymentRequestCostSourceCode

public void setPaymentRequestCostSourceCode(String paymentRequestCostSourceCode)

getPaymentRequestedCancelIndicator

public boolean getPaymentRequestedCancelIndicator()

isPaymentRequestedCancelIndicator

public boolean isPaymentRequestedCancelIndicator()

setPaymentRequestedCancelIndicator

public void setPaymentRequestedCancelIndicator(boolean paymentRequestedCancelIndicator)

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)

getPaymentRequestElectronicInvoiceIndicator

public boolean getPaymentRequestElectronicInvoiceIndicator()

setPaymentRequestElectronicInvoiceIndicator

public void setPaymentRequestElectronicInvoiceIndicator(boolean paymentRequestElectronicInvoiceIndicator)

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)

isPaymentRequestPositiveApprovalIndicator

public boolean isPaymentRequestPositiveApprovalIndicator()

Gets the paymentRequestPositiveApprovalIndicator attribute.

Returns:

Returns the paymentRequestPositiveApprovalIndicator.

setPaymentRequestPositiveApprovalIndicator

public void setPaymentRequestPositiveApprovalIndicator(boolean paymentRequestPositiveApprovalIndicator)

Sets the paymentRequestPositiveApprovalIndicator attribute value.

Parameters:

paymentRequestPositiveApprovalIndicator - The paymentRequestPositiveApprovalIndicator 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()

Perform logic needed to initiate PREQ Document

clearInitFields

public void clearInitFields()

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

populatePaymentRequestFromPurchaseOrder

public void populatePaymentRequestFromPurchaseOrder(PurchaseOrderDocument po)

Populates a preq from a PO - delegate method

Parameters:

po - -

populatePaymentRequestFromPurchaseOrder

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

Populates a preq from a PO

Parameters:

po - Purchase Order Document used for populating the PREQ

expiredOrClosedAccountList - a list of closed or expired accounts

getDocumentTitle

public String getDocumentTitle()

Specified by:

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

Overrides:

getDocumentTitle in class org.kuali.rice.kns.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.dto.DocumentRouteStatusChangeDTO 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.kns.document.Document

Overrides:

doRouteStatusChange in class GeneralLedgerPostingDocumentBase

See Also:

org.kuali.rice.kns.document.DocumentBase#doRouteStatusChange()

doActionTaken

public void doActionTaken(org.kuali.rice.kew.dto.ActionTakenEventDTO event)

Generates correcting entries to the GL if accounts are modified.

Specified by:

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

Overrides:

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

See Also:

org.kuali.rice.kns.document.Document#doActionTaken(org.kuali.rice.kew.clientapp.vo.ActionTakenEventDTO)

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:

org.kuali.kfs.module.purap.document.AccountsPayableDocumentBase#preProcessNodeChange(java.lang.String, java.lang.String)

getNodeDetailEnum

public PurapWorkflowConstants.NodeDetails getNodeDetailEnum(String nodeName)

Description copied from class: AccountsPayableDocumentBase

Retrieves node details object based on name.

Specified by:

getNodeDetailEnum in class AccountsPayableDocumentBase

Parameters:

nodeName - - route level

Returns:

- Information about the supplied route level

See Also:

AccountsPayableDocumentBase.getNodeDetailEnum(java.lang.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.kns.util.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.kns.util.KualiDecimal getItemTotalPoEncumbranceAmountRelieved()

getItemTotalPoEncumbranceAmountRelieved

public org.kuali.rice.kns.util.KualiDecimal getItemTotalPoEncumbranceAmountRelieved(boolean includeBelowTheLine)

getLineItemTotal

public org.kuali.rice.kns.util.KualiDecimal getLineItemTotal()

getLineItemPreTaxTotal

public org.kuali.rice.kns.util.KualiDecimal getLineItemPreTaxTotal()

getLineItemTaxAmount

public org.kuali.rice.kns.util.KualiDecimal getLineItemTaxAmount()

getGrandTotal

public org.kuali.rice.kns.util.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.kns.util.KualiDecimal getGrandTotalExcludingDiscount()

setGrandTotalExcludingDiscount

public void setGrandTotalExcludingDiscount(org.kuali.rice.kns.util.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.kns.util.KualiDecimal getGrandPreTaxTotal()

getGrandPreTaxTotalExcludingDiscount

public org.kuali.rice.kns.util.KualiDecimal getGrandPreTaxTotalExcludingDiscount()

getGrandTaxAmount

public org.kuali.rice.kns.util.KualiDecimal getGrandTaxAmount()

getGrandTaxAmountExcludingDiscount

public org.kuali.rice.kns.util.KualiDecimal getGrandTaxAmountExcludingDiscount()

isDiscount

public boolean isDiscount()

getItemTotalPoPaidAmount

public org.kuali.rice.kns.util.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.kns.util.KualiDecimal amount)

Exists due to a setter requirement by the htmlControlAttribute

Parameters:

amount - - total po amount paid

setItemTotalPoEncumbranceAmount

public void setItemTotalPoEncumbranceAmount(org.kuali.rice.kns.util.KualiDecimal amount)

Exists due to a setter requirement by the htmlControlAttribute

Parameters:

amount - - total po encumbrance

setItemTotalPoEncumbranceAmountRelieved

public void setItemTotalPoEncumbranceAmountRelieved(org.kuali.rice.kns.util.KualiDecimal amount)

Exists due to a setter requirement by the htmlControlAttribute

Parameters:

amount - - total po encumbrance amount relieved

getCurrentRouteLevels

protected List getCurrentRouteLevels(org.kuali.rice.kns.workflow.service.KualiWorkflowDocument workflowDocument)

Determinines the route levels for a given document.

Parameters:

workflowDocument - - work flow document

Returns:

List - list of route levels

getStatusDescription

public String getStatusDescription()

Deprecated.

USED FOR ROUTING ONLY

setStatusDescription

public void setStatusDescription(String statusDescription)

Deprecated.

USED FOR ROUTING ONLY

getRecurringPaymentType

public RecurringPaymentType getRecurringPaymentType()

setRecurringPaymentType

public void setRecurringPaymentType(RecurringPaymentType recurringPaymentType)

getPaymentRequestCostSource

public PurchaseOrderCostSource getPaymentRequestCostSource()

setPaymentRequestCostSource

public void setPaymentRequestCostSource(PurchaseOrderCostSource paymentRequestCostSource)

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:

org.kuali.kfs.module.purap.document.AccountsPayableDocumentBase#getPoDocumentTypeForAccountsPayableDocumentApprove()

getInitialAmount

public org.kuali.rice.kns.util.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.kns.rule.event.KualiDocumentEvent event)

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

Specified by:

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

Overrides:

prepareForSave in class AccountsPayableDocumentBase

See Also:

Document.prepareForSave(org.kuali.rice.kns.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

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.kfs.sys.document.AccountingDocument, org.kuali.kfs.sys.businessobject.AccountingLine, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry)

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Provides answers to the following splits: PurchaseWasReceived VendorIsEmployeeOrNonResidentAlien

Specified by:

answerSplitNodeQuestion in interface FinancialSystemTransactionalDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(java.lang.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 - preqQtyInvoiced)). We have to subtract preqQtyInvoiced from the poQtyInvoiced because this payment request has already updated the totals on the po.

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.kns.util.KualiDecimal getTaxFederalPercentShort()

getTaxFederalPercent

public BigDecimal getTaxFederalPercent()

setTaxFederalPercent

public void setTaxFederalPercent(BigDecimal taxFederalPercent)

getTaxStatePercentShort

public org.kuali.rice.kns.util.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.kns.util.KualiDecimal getTaxSpecialW4Amount()

setTaxSpecialW4Amount

public void setTaxSpecialW4Amount(org.kuali.rice.kns.util.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)

isPaymentRequestedCancelIndicatorForSearching

public boolean isPaymentRequestedCancelIndicatorForSearching()

getPaymentRequestPositiveApprovalIndicatorForSearching

public boolean getPaymentRequestPositiveApprovalIndicatorForSearching()

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