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

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

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

Direct Known Subclasses:

PaymentRequestDocument, VendorCreditMemoDocument

public abstract class AccountsPayableDocumentBase
extends PurchasingAccountsPayableDocumentBase
implements AccountsPayableDocument

Accounts Payable Document Base

See Also:

Serialized Form

Field Summary

protected Timestamp	accountsPayableApprovalTimestamp
protected String	accountsPayableProcessorIdentifier
protected Bank	bank
protected String	bankCode
protected String	chartOfAccountsCode
protected boolean	closePurchaseOrderIndicator
protected boolean	continuationAccountIndicator
protected String	debitCreditCodeForGLEntries
protected Timestamp	extractedTimestamp
protected boolean	generateEncumbranceEntries
protected boolean	holdIndicator
protected String	lastActionPerformedByPersonId
protected static org.apache.log4j.Logger	LOG
protected String	noteLine1Text
protected String	noteLine2Text
protected String	noteLine3Text
protected PurApItemUseTax	offsetUseTax
protected String	organizationCode
protected CampusParameter	processingCampus
protected String	processingCampusCode
protected PurchaseOrderDocument	purchaseOrderDocument
protected Integer	purchaseOrderIdentifier
protected boolean	reopenPurchaseOrderIndicator
protected boolean	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

AccountsPayableDocumentBase()
Constructs a AccountsPayableDocumentBase

Method Summary

boolean	approvalAtAccountsPayableReviewAllowed() Determines if approval is an option during review.
boolean	customizeOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry)
abstract boolean	documentHasNoImagesAttached() Checks all documents notes for attachments and to be overriden by sub class
void	doRouteLevelChange(org.kuali.rice.kew.dto.DocumentRouteLevelChangeDTO levelChangeEvent)
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, PurApItemUseTax offsetUseTax)
Timestamp	getAccountsPayableApprovalTimestamp()
String	getAccountsPayableProcessorIdentifier()
AccountsPayableItem	getAPItemFromPOItem(PurchaseOrderItem poi)
Bank	getBank()
String	getBankCode()
String	getChartOfAccountsCode()
String	getDebitCreditCodeForGLEntries()
String	getDocumentChartOfAccountsCodeForSearching()
String	getDocumentOrganizationCodeForSearching()
abstract AccountsPayableDocumentSpecificService	getDocumentSpecificService()
String	getDocumentType()
boolean	getExtractedIndicatorForSearching()
Timestamp	getExtractedTimestamp()
abstract org.kuali.rice.kns.util.KualiDecimal	getGrandTotal() Retrieves grand total amount for document.
String	getHoldIndicatorForResult()
abstract org.kuali.rice.kns.util.KualiDecimal	getInitialAmount() Returns the amount entered on the initial screen.
Class	getItemClass() Returns the Item Class.
String	getLastActionPerformedByPersonId()
String	getLastActionPerformedByPersonName() Retrieves the person name for the last person to perform an action on the document.
org.kuali.rice.kim.bo.Person	getLastActionPerformedByUser() Retrieves the universal user object for the last person to perform an action on the document.
abstract PurapWorkflowConstants.NodeDetails	getNodeDetailEnum(String nodeName) Retrieves node details object based on name.
String	getNoteLine1Text()
String	getNoteLine2Text()
String	getNoteLine3Text()
String	getOrganizationCode()
abstract String	getPoDocumentTypeForAccountsPayableDocumentCancel() Helper method to be called from custom prepare for save and to be overriden by sub class.
CampusParameter	getProcessingCampus()
String	getProcessingCampusCode()
String	getProcessingCampusCodeForSearch()
PurchasingAccountsPayableDocument	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()
Integer	getPurchaseOrderIdentifier()
org.kuali.rice.kns.util.KualiDecimal	getTotalRemitTax() This method returns the amount of tax to remit to the vendor
protected abstract boolean	isAttachmentRequired() Checks whether an attachment is required
boolean	isClosePurchaseOrderIndicator()
boolean	isContinuationAccountIndicator()
boolean	isExtracted() Determines if document has been extracted.
boolean	isGenerateEncumbranceEntries()
boolean	isHoldIndicator()
boolean	isHoldIndicatorForSearching()
boolean	isReopenPurchaseOrderIndicator()
boolean	isUnmatchedOverride()
void	populateDocumentForRouting()
void	prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event) Calls a custom prepare for save method, as the super class does GL entry creation that causes problems with AP documents.
abstract boolean	processNodeChange(String newNodeName, String oldNodeName) Hook to allow processing after a route level is passed.
protected void	removeGeneralLedgerPendingEntries() Overriding to stop the deleting of general ledger entries.
boolean	requiresAccountsPayableReviewRouting() Determines if review route node is required.
abstract void	saveDocumentFromPostProcessing() Hook point to allow processing after a save.
void	setAccountsPayableApprovalTimestamp(Timestamp accountsPayableApprovalTimestamp)
void	setAccountsPayableProcessorIdentifier(String accountsPayableProcessorIdentifier)
void	setBank(Bank bank)
void	setBankCode(String bankCode)
void	setChartOfAccountsCode(String chartOfAccountsCode)
void	setClosePurchaseOrderIndicator(boolean closePurchaseOrderIndicator)
void	setContinuationAccountIndicator(boolean continuationAccountIndicator)
void	setDebitCreditCodeForGLEntries(String debitCreditCodeForGLEntries)
void	setExtractedTimestamp(Timestamp extractedTimestamp)
void	setGenerateEncumbranceEntries(boolean generateEncumbranceEntries)
void	setGrandTotal(org.kuali.rice.kns.util.KualiDecimal total)
void	setHoldIndicator(boolean holdIndicator)
void	setLastActionPerformedByPersonId(String lastActionPerformedByPersonId)
void	setLineItemTotal(org.kuali.rice.kns.util.KualiDecimal total)
void	setNoteLine1Text(String noteLine1Text)
void	setNoteLine2Text(String noteLine2Text)
void	setNoteLine3Text(String noteLine3Text)
void	setOrganizationCode(String organizationCode)
void	setProcessingCampus(CampusParameter processingCampus) Deprecated.
void	setProcessingCampusCode(String processingCampusCode)
void	setPurchaseOrderDocument(PurchaseOrderDocument purchaseOrderDocument)
void	setPurchaseOrderIdentifier(Integer purchaseOrderIdentifier)
void	setReopenPurchaseOrderIndicator(boolean reopenPurchaseOrderIndicator)
void	setUnmatchedOverride(boolean unmatchedOverride)
boolean	shouldGiveErrorForEmptyAccountsProration()
void	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, getItem, getItemByItemIdentifier, getItemByLineNumber, getItemByStringIdentifier, getItemLinePosition, getItems, getItemUseTaxClass, 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, isInquiryRendered, 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, customizeExplicitGeneralLedgerPendingEntry, 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, doRouteStatusChange, 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

answerSplitNodeQuestion, 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, doActionTaken, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, 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, isBoNotesSupport, 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, getItem, getItemLinePosition, getItems, getPostingYearNextOrCurrent, getPurapDocumentIdentifier, getStatus, getStatusCode, getTotalDollarAmount, getTotalDollarAmountAboveLineItems, getTotalDollarAmountAllItems, getTotalDollarAmountForTradeIn, getTotalPreTaxDollarAmount, getTotalPreTaxDollarAmountAllItems, getTotalTaxAmount, getTotalTaxAmountAboveLineItems, getTotalTaxAmountAboveLineItems, getTotalTaxAmountAllItems, getTotalTaxAmountWithExclusions, getTradeInItem, getTradeInItems, getTransactionTaxDate, getVendorAddressGeneratedIdentifier, getVendorAddressInternationalProvinceName, getVendorCityName, getVendorCountry, getVendorCountryCode, getVendorCustomerNumber, getVendorDetail, getVendorDetailAssignedIdentifier, getVendorHeaderGeneratedIdentifier, getVendorLine1Address, getVendorLine2Address, getVendorName, getVendorNumber, getVendorPostalCode, getVendorStateCode, isDocumentStoppedInRouteNode, isInquiryRendered, isPostingYearNext, isPostingYearPrior, isUseTaxIndicator, itemSwap, renumberItems, setAccountsPayablePurchasingDocumentLinkIdentifier, setItems, setPurapDocumentIdentifier, setStatusCode, setTotalDollarAmount, setTotalPreTaxDollarAmount, setTotalTaxAmount, setUseTaxIndicator, setVendorAddressGeneratedIdentifier, setVendorAddressInternationalProvinceName, setVendorCityName, setVendorCountryCode, setVendorCustomerNumber, setVendorDetailAssignedIdentifier, setVendorHeaderGeneratedIdentifier, setVendorLine1Address, setVendorLine2Address, setVendorName, setVendorNumber, setVendorPostalCode, setVendorStateCode, templateVendorAddress

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

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

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

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

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

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.kfs.sys.document.FinancialSystemTransactionalDocument

answerSplitNodeQuestion, getDocumentHeader

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

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, 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, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

prepareForWorkflow, refresh

Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate

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

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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

accountsPayableApprovalTimestamp

protected Timestamp accountsPayableApprovalTimestamp

lastActionPerformedByPersonId

protected String lastActionPerformedByPersonId

accountsPayableProcessorIdentifier

protected String accountsPayableProcessorIdentifier

holdIndicator

protected boolean holdIndicator

extractedTimestamp

protected Timestamp extractedTimestamp

purchaseOrderIdentifier

protected Integer purchaseOrderIdentifier

processingCampusCode

protected String processingCampusCode

noteLine1Text

protected String noteLine1Text

noteLine2Text

protected String noteLine2Text

noteLine3Text

protected String noteLine3Text

continuationAccountIndicator

protected boolean continuationAccountIndicator

closePurchaseOrderIndicator

protected boolean closePurchaseOrderIndicator

reopenPurchaseOrderIndicator

protected boolean reopenPurchaseOrderIndicator

bankCode

protected String bankCode

unmatchedOverride

protected boolean unmatchedOverride

chartOfAccountsCode

protected String chartOfAccountsCode

organizationCode

protected String organizationCode

generateEncumbranceEntries

protected boolean generateEncumbranceEntries

debitCreditCodeForGLEntries

protected String debitCreditCodeForGLEntries

offsetUseTax

protected PurApItemUseTax offsetUseTax

processingCampus

protected CampusParameter processingCampus

purchaseOrderDocument

protected transient PurchaseOrderDocument purchaseOrderDocument

bank

protected Bank bank

Constructor Detail

AccountsPayableDocumentBase

public AccountsPayableDocumentBase()

Constructs a AccountsPayableDocumentBase

Method Detail

setLineItemTotal

public void setLineItemTotal(org.kuali.rice.kns.util.KualiDecimal total)

setGrandTotal

public void setGrandTotal(org.kuali.rice.kns.util.KualiDecimal total)

removeGeneralLedgerPendingEntries

protected void removeGeneralLedgerPendingEntries()

Overriding to stop the deleting of general ledger entries.

Overrides:

removeGeneralLedgerPendingEntries in class GeneralLedgerPostingDocumentBase

See Also:

GeneralLedgerPostingDocumentBase.removeGeneralLedgerPendingEntries()

requiresAccountsPayableReviewRouting

public boolean requiresAccountsPayableReviewRouting()

Description copied from interface: AccountsPayableDocument

Determines if review route node is required.

Specified by:

requiresAccountsPayableReviewRouting in interface AccountsPayableDocument

Returns:

- true if review is required, false otherwise.

See Also:

AccountsPayableDocument.requiresAccountsPayableReviewRouting()

approvalAtAccountsPayableReviewAllowed

public boolean approvalAtAccountsPayableReviewAllowed()

Description copied from interface: AccountsPayableDocument

Determines if approval is an option during review.

Specified by:

approvalAtAccountsPayableReviewAllowed in interface AccountsPayableDocument

Returns:

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

See Also:

AccountsPayableDocument.approvalAtAccountsPayableReviewAllowed()

isAttachmentRequired

protected abstract boolean isAttachmentRequired()

Checks whether an attachment is required

Returns:

- true if attachment is required, otherwise false

documentHasNoImagesAttached

public abstract boolean documentHasNoImagesAttached()

Checks all documents notes for attachments and to be overriden by sub class

Returns:

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

populateDocumentForRouting

public void populateDocumentForRouting()

Specified by:

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

Overrides:

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

See Also:

DocumentBase.populateDocumentForRouting()

prepareForSave

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

Calls a custom prepare for save method, as the super class does GL entry creation that causes problems with AP documents.

Specified by:

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

Overrides:

prepareForSave in class PurchasingAccountsPayableDocumentBase

See Also:

PurchasingAccountsPayableDocumentBase.prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent)

getPoDocumentTypeForAccountsPayableDocumentCancel

public abstract String getPoDocumentTypeForAccountsPayableDocumentCancel()

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

Returns:

- Po Document Type

doRouteLevelChange

public void doRouteLevelChange(org.kuali.rice.kew.dto.DocumentRouteLevelChangeDTO levelChangeEvent)

Specified by:

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

Overrides:

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

See Also:

org.kuali.rice.kns.document.DocumentBase#handleRouteLevelChange(org.kuali.rice.kew.clientapp.vo.DocumentRouteLevelChangeDTO)

processNodeChange

public abstract boolean processNodeChange(String newNodeName,
                                          String oldNodeName)

Hook to allow processing after a route level is passed.

Parameters:

newNodeName - - current route level

oldNodeName - - previous route level

Returns:

- true if process completes to valid state

getNodeDetailEnum

public abstract PurapWorkflowConstants.NodeDetails getNodeDetailEnum(String nodeName)

Retrieves node details object based on name.

Parameters:

nodeName - - route level

Returns:

- Information about the supplied route level

saveDocumentFromPostProcessing

public abstract void saveDocumentFromPostProcessing()

Hook point to allow processing after a save.

getPurchaseOrderIdentifier

public Integer getPurchaseOrderIdentifier()

Specified by:

getPurchaseOrderIdentifier in interface AccountsPayableDocument

setPurchaseOrderIdentifier

public void setPurchaseOrderIdentifier(Integer purchaseOrderIdentifier)

Specified by:

setPurchaseOrderIdentifier in interface AccountsPayableDocument

getAccountsPayableProcessorIdentifier

public String getAccountsPayableProcessorIdentifier()

Specified by:

getAccountsPayableProcessorIdentifier in interface AccountsPayableDocument

setAccountsPayableProcessorIdentifier

public void setAccountsPayableProcessorIdentifier(String accountsPayableProcessorIdentifier)

Specified by:

setAccountsPayableProcessorIdentifier in interface AccountsPayableDocument

getLastActionPerformedByPersonId

public String getLastActionPerformedByPersonId()

Specified by:

getLastActionPerformedByPersonId in interface AccountsPayableDocument

setLastActionPerformedByPersonId

public void setLastActionPerformedByPersonId(String lastActionPerformedByPersonId)

Specified by:

setLastActionPerformedByPersonId in interface AccountsPayableDocument

getProcessingCampusCode

public String getProcessingCampusCode()

Specified by:

getProcessingCampusCode in interface AccountsPayableDocument

setProcessingCampusCode

public void setProcessingCampusCode(String processingCampusCode)

Specified by:

setProcessingCampusCode in interface AccountsPayableDocument

getAccountsPayableApprovalTimestamp

public Timestamp getAccountsPayableApprovalTimestamp()

Specified by:

getAccountsPayableApprovalTimestamp in interface AccountsPayableDocument

setAccountsPayableApprovalTimestamp

public void setAccountsPayableApprovalTimestamp(Timestamp accountsPayableApprovalTimestamp)

Specified by:

setAccountsPayableApprovalTimestamp in interface AccountsPayableDocument

getExtractedTimestamp

public Timestamp getExtractedTimestamp()

Specified by:

getExtractedTimestamp in interface AccountsPayableDocument

setExtractedTimestamp

public void setExtractedTimestamp(Timestamp extractedTimestamp)

Specified by:

setExtractedTimestamp in interface AccountsPayableDocument

isHoldIndicator

public boolean isHoldIndicator()

Specified by:

isHoldIndicator in interface AccountsPayableDocument

setHoldIndicator

public void setHoldIndicator(boolean holdIndicator)

Specified by:

setHoldIndicator in interface AccountsPayableDocument

getNoteLine1Text

public String getNoteLine1Text()

Specified by:

getNoteLine1Text in interface AccountsPayableDocument

setNoteLine1Text

public void setNoteLine1Text(String noteLine1Text)

Specified by:

setNoteLine1Text in interface AccountsPayableDocument

getNoteLine2Text

public String getNoteLine2Text()

Specified by:

getNoteLine2Text in interface AccountsPayableDocument

setNoteLine2Text

public void setNoteLine2Text(String noteLine2Text)

Specified by:

setNoteLine2Text in interface AccountsPayableDocument

getNoteLine3Text

public String getNoteLine3Text()

Specified by:

getNoteLine3Text in interface AccountsPayableDocument

setNoteLine3Text

public void setNoteLine3Text(String noteLine3Text)

Specified by:

setNoteLine3Text in interface AccountsPayableDocument

getProcessingCampus

public CampusParameter getProcessingCampus()

Specified by:

getProcessingCampus in interface AccountsPayableDocument

getChartOfAccountsCode

public String getChartOfAccountsCode()

setChartOfAccountsCode

public void setChartOfAccountsCode(String chartOfAccountsCode)

getOrganizationCode

public String getOrganizationCode()

setOrganizationCode

public void setOrganizationCode(String organizationCode)

isGenerateEncumbranceEntries

public boolean isGenerateEncumbranceEntries()

setGenerateEncumbranceEntries

public void setGenerateEncumbranceEntries(boolean generateEncumbranceEntries)

getPurchaseOrderDocument

public PurchaseOrderDocument getPurchaseOrderDocument()

Specified by:

getPurchaseOrderDocument in interface AccountsPayableDocument

See Also:

AccountsPayableDocument.getPurchaseOrderDocument()

setPurchaseOrderDocument

public void setPurchaseOrderDocument(PurchaseOrderDocument purchaseOrderDocument)

Specified by:

setPurchaseOrderDocument in interface AccountsPayableDocument

See Also:

AccountsPayableDocument.setPurchaseOrderDocument(org.kuali.kfs.module.purap.document.PurchaseOrderDocument)

isClosePurchaseOrderIndicator

public boolean isClosePurchaseOrderIndicator()

setClosePurchaseOrderIndicator

public void setClosePurchaseOrderIndicator(boolean closePurchaseOrderIndicator)

isReopenPurchaseOrderIndicator

public boolean isReopenPurchaseOrderIndicator()

setReopenPurchaseOrderIndicator

public void setReopenPurchaseOrderIndicator(boolean reopenPurchaseOrderIndicator)

getBankCode

public String getBankCode()

setBankCode

public void setBankCode(String bankCode)

getBank

public Bank getBank()

setBank

public void setBank(Bank bank)

setProcessingCampus

public void setProcessingCampus(CampusParameter processingCampus)

Deprecated.

Sets the processing campus.

Parameters:

processingCampus -

getLastActionPerformedByUser

public org.kuali.rice.kim.bo.Person getLastActionPerformedByUser()

Retrieves the universal user object for the last person to perform an action on the document.

getLastActionPerformedByPersonName

public String getLastActionPerformedByPersonName()

Retrieves the person name for the last person to perform an action on the document.

Returns:

- the person's name who last performed an action on the document.

getDebitCreditCodeForGLEntries

public String getDebitCreditCodeForGLEntries()

setDebitCreditCodeForGLEntries

public void setDebitCreditCodeForGLEntries(String debitCreditCodeForGLEntries)

isUnmatchedOverride

public boolean isUnmatchedOverride()

Specified by:

isUnmatchedOverride in interface AccountsPayableDocument

setUnmatchedOverride

public void setUnmatchedOverride(boolean unmatchedOverride)

Specified by:

setUnmatchedOverride in interface AccountsPayableDocument

getExtractedIndicatorForSearching

public boolean getExtractedIndicatorForSearching()

isHoldIndicatorForSearching

public boolean isHoldIndicatorForSearching()

getGrandTotal

public abstract org.kuali.rice.kns.util.KualiDecimal getGrandTotal()

Description copied from interface: AccountsPayableDocument

Retrieves grand total amount for document.

Specified by:

getGrandTotal in interface AccountsPayableDocument

Returns:

- grand total

See Also:

AccountsPayableDocument.getGrandTotal()

getInitialAmount

public abstract 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

Returns:

- amount entered by user on initial screen

See Also:

AccountsPayableDocument.getInitialAmount()

isContinuationAccountIndicator

public boolean isContinuationAccountIndicator()

Specified by:

isContinuationAccountIndicator in interface AccountsPayableDocument

setContinuationAccountIndicator

public void setContinuationAccountIndicator(boolean continuationAccountIndicator)

Specified by:

setContinuationAccountIndicator in interface AccountsPayableDocument

isExtracted

public boolean isExtracted()

Description copied from interface: AccountsPayableDocument

Determines if document has been extracted.

Specified by:

isExtracted in interface AccountsPayableDocument

Returns:

- true if document has been extracted, false otherwise.

getDocumentSpecificService

public abstract AccountsPayableDocumentSpecificService getDocumentSpecificService()

Specified by:

getDocumentSpecificService in interface AccountsPayableDocument

getAPItemFromPOItem

public AccountsPayableItem getAPItemFromPOItem(PurchaseOrderItem poi)

Specified by:

getAPItemFromPOItem in interface AccountsPayableDocument

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

Specified by:

getItemClass in class PurchasingAccountsPayableDocumentBase

Returns:

the Item Class.

See Also:

PurchasingAccountsPayableDocumentBase.getItemClass()

getPurApSourceDocumentIfPossible

public PurchasingAccountsPayableDocument getPurApSourceDocumentIfPossible()

Description copied from interface: PurchasingAccountsPayableDocument

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

Specified by:

getPurApSourceDocumentIfPossible in interface PurchasingAccountsPayableDocument

Specified by:

getPurApSourceDocumentIfPossible in class PurchasingAccountsPayableDocumentBase

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

Specified by:

getPurApSourceDocumentLabelIfPossible in class PurchasingAccountsPayableDocumentBase

Returns:

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

See Also:

PurchasingAccountsPayableDocumentBase.getPurApSourceDocumentLabelIfPossible()

updateExtendedPriceOnItems

public void updateExtendedPriceOnItems()

getTotalRemitTax

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

Description copied from interface: AccountsPayableDocument

This method returns the amount of tax to remit to the vendor

Specified by:

getTotalRemitTax in interface AccountsPayableDocument

Returns:

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

See Also:

org.kuali.kfs.module.purap.document.AccountsPayableDocument#getTotalRemitAmount()

customizeOffsetGeneralLedgerPendingEntry

public boolean customizeOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine,
                                                        GeneralLedgerPendingEntry explicitEntry,
                                                        GeneralLedgerPendingEntry offsetEntry)

Overrides:

customizeOffsetGeneralLedgerPendingEntry in class AccountingDocumentBase

generateGeneralLedgerPendingEntries

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

Specified by:

generateGeneralLedgerPendingEntries in interface AccountsPayableDocument

getHoldIndicatorForResult

public String getHoldIndicatorForResult()

getProcessingCampusCodeForSearch

public String getProcessingCampusCodeForSearch()

getDocumentChartOfAccountsCodeForSearching

public String getDocumentChartOfAccountsCodeForSearching()

getDocumentOrganizationCodeForSearching

public String getDocumentOrganizationCodeForSearching()

getDocumentType

public String getDocumentType()

Returns:

workflow document type for the purap document

shouldGiveErrorForEmptyAccountsProration

public boolean shouldGiveErrorForEmptyAccountsProration()

Specified by:

shouldGiveErrorForEmptyAccountsProration in interface PurchasingAccountsPayableDocument