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

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.VendorCreditMemoDocument

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 VendorCreditMemoDocument
extends AccountsPayableDocumentBase

Credit Memo Document Business Object. Contains the fields associated with the main document table.

See Also:

Serialized Form

Field Summary

protected org.kuali.rice.kns.util.KualiDecimal	creditMemoAmount
protected Date	creditMemoDate
protected String	creditMemoNumber
protected Timestamp	creditMemoPaidTimestamp
protected String	itemMiscellaneousCreditDescription
protected static org.apache.log4j.Logger	LOG
protected PaymentRequestDocument	paymentRequestDocument
protected Integer	paymentRequestIdentifier
protected Date	purchaseOrderEndDate
protected String	vendorAttentionName

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, 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

VendorCreditMemoDocument()
Default constructor.

Method Summary

boolean	answerSplitNodeQuestion(String nodeName) Provides answers to the following splits: RequiresInvoiceAttachment
void	clearInitFields() Clear out the initially populated fields.
void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) Forces GL entries to be approved before document final approval.
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.
org.kuali.rice.kns.util.KualiDecimal	getCreditMemoAmount()
Date	getCreditMemoDate()
String	getCreditMemoNumber()
Timestamp	getCreditMemoPaidTimestamp()
String	getCreditMemoType() Returns the type of the Credit Memo that was selected on the init screen.
protected String	getCustomDocumentTitle() Returns a custom document title based on the workflow document title.
AccountsPayableDocumentSpecificService	getDocumentSpecificService()
String	getDocumentTitle()
org.kuali.rice.kns.util.KualiDecimal	getGrandPreTaxTotal() Calculates the credit memo pretax total: Sum of above the line - restocking fees + misc amount
org.kuali.rice.kns.util.KualiDecimal	getGrandPreTaxTotalExcludingRestockingFee()
org.kuali.rice.kns.util.KualiDecimal	getGrandTaxAmount() Calculates the credit memo tax amount: Sum of above the line -
org.kuali.rice.kns.util.KualiDecimal	getGrandTotal() Calculates the credit memo total: Sum of above the line - restocking fees + misc amount
org.kuali.rice.kns.util.KualiDecimal	getGrandTotalExcludingRestockingFee()
org.kuali.rice.kns.util.KualiDecimal	getInitialAmount() Returns the amount entered on the initial screen.
Class<CreditMemoItem>	getItemClass() Returns the Item Class.
String	getItemMiscellaneousCreditDescription()
Class	getItemUseTaxClass()
org.kuali.rice.kns.util.KualiDecimal	getLineItemPreTaxTotal() Calculates the pretax total of the above the line items
org.kuali.rice.kns.util.KualiDecimal	getLineItemTotal() Calculates the total of the above the line items
PurapWorkflowConstants.NodeDetails	getNodeDetailEnum(String nodeName) Retrieves node details object based on name.
String	getPaidIndicatorForResult()
PaymentRequestDocument	getPaymentRequest() Deprecated.
PaymentRequestDocument	getPaymentRequestDocument()
Integer	getPaymentRequestIdentifier()
String	getPoDocumentTypeForAccountsPayableDocumentCancel() Helper method to be called from custom prepare for save and to be overriden by sub class.
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	getPurchaseOrder() Deprecated.
Date	getPurchaseOrderEndDate()
boolean	getPurchaseOrderNotes() Determines if the purchase order has notes, using the note service.
String	getStatusDescription() Deprecated.
protected String	getTitleIndicator() Determines the indicator text that will appear in the workflow document title
Date	getTransactionTaxDate()
String	getVendorAttentionName()
void	initiateDocument() Initializes the values for a new document.
protected boolean	isAttachmentRequired() Checks whether an attachment is required
boolean	isBoNotesSupport()
boolean	isInquiryRendered() Overrides the method in PurchasingAccountsPayableDocumentBase to add the criteria specific to Credit Memo Document.
boolean	isSourceDocumentPaymentRequest()
boolean	isSourceDocumentPurchaseOrder()
boolean	isSourceVendor()
void	prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event) Credit Memo document is first populated on Continue AP Event, and then prepareForSave continues.
boolean	processNodeChange(String newNodeName, String oldNodeName) Hook point for performing actions that occur after a route level change, in this case; Performs logic necessary after full entry has been completed when past Adhoc Review, or sets the AP approval date when past AP review.
void	saveDocumentFromPostProcessing() Hook point to allow processing after a save.
void	setCreditMemoAmount(org.kuali.rice.kns.util.KualiDecimal creditMemoAmount)
void	setCreditMemoDate(Date creditMemoDate)
void	setCreditMemoNumber(String creditMemoNumber)
void	setCreditMemoPaidTimestamp(Timestamp creditMemoPaidTimestamp)
void	setItemMiscellaneousCreditDescription(String itemMiscellaneousCreditDescription)
void	setPaymentRequest(PaymentRequestDocument paymentRequest) Deprecated.
void	setPaymentRequestDocument(PaymentRequestDocument paymentRequestDocument)
void	setPaymentRequestIdentifier(Integer paymentRequestIdentifier)
void	setPurchaseOrder(PurchaseOrderDocument purchaseOrder) Deprecated.
void	setPurchaseOrderEndDate(Date purchaseOrderEndDate)
void	setStatusDescription(String statusDescription) Deprecated.
void	setVendorAttentionName(String vendorAttentionName)

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, populateDocumentForRouting, removeGeneralLedgerPendingEntries, requiresAccountsPayableReviewRouting, setAccountsPayableApprovalTimestamp, setAccountsPayableProcessorIdentifier, setBank, setBankCode, setChartOfAccountsCode, setClosePurchaseOrderIndicator, setContinuationAccountIndicator, setDebitCreditCodeForGLEntries, setExtractedTimestamp, setGenerateEncumbranceEntries, setGrandTotal, setHoldIndicator, setLastActionPerformedByPersonId, setLineItemTotal, setNoteLine1Text, setNoteLine2Text, setNoteLine3Text, setOrganizationCode, setProcessingCampus, setProcessingCampusCode, setPurchaseOrderDocument, setPurchaseOrderIdentifier, setReopenPurchaseOrderIndicator, setUnmatchedOverride, shouldGiveErrorForEmptyAccountsProration, updateExtendedPriceOnItems

Methods inherited from class org.kuali.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, 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, 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, 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, doActionTaken, 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, getItem, 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, doActionTaken, 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

paymentRequestIdentifier

protected Integer paymentRequestIdentifier

creditMemoNumber

protected String creditMemoNumber

creditMemoDate

protected Date creditMemoDate

creditMemoAmount

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

creditMemoPaidTimestamp

protected Timestamp creditMemoPaidTimestamp

itemMiscellaneousCreditDescription

protected String itemMiscellaneousCreditDescription

purchaseOrderEndDate

protected Date purchaseOrderEndDate

vendorAttentionName

protected String vendorAttentionName

paymentRequestDocument

protected PaymentRequestDocument paymentRequestDocument

Constructor Detail

VendorCreditMemoDocument

public VendorCreditMemoDocument()

Default constructor.

Method Detail

isSourceDocumentPaymentRequest

public boolean isSourceDocumentPaymentRequest()

isSourceDocumentPurchaseOrder

public boolean isSourceDocumentPurchaseOrder()

isSourceVendor

public boolean isSourceVendor()

isInquiryRendered

public boolean isInquiryRendered()

Overrides the method in PurchasingAccountsPayableDocumentBase to add the criteria specific to Credit Memo Document.

Specified by:

isInquiryRendered in interface PurchasingAccountsPayableDocument

Overrides:

isInquiryRendered in class PurchasingAccountsPayableDocumentBase

Returns:

See Also:

PurchasingAccountsPayableDocumentBase.isInquiryRendered()

initiateDocument

public void initiateDocument()

Initializes the values for a new document.

clearInitFields

public void clearInitFields()

Clear out the initially populated fields.

getCreditMemoType

public String getCreditMemoType()

Returns the type of the Credit Memo that was selected on the init screen. It is based on them entering the Vendor, PO or PREQ #.

Returns:

Vendor, PO or PREQ

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

getPurchaseOrderNotes

public boolean getPurchaseOrderNotes()

Determines if the purchase order has notes, using the note service.

Returns:

- true if po has notes, false if po does not have notes

getTitleIndicator

protected String getTitleIndicator()

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

Returns:

- Text of hold

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

processNodeChange

public boolean processNodeChange(String newNodeName,
                                 String oldNodeName)

Hook point for performing actions that occur after a route level change, in this case; Performs logic necessary after full entry has been completed when past Adhoc Review, or sets the AP approval date when past AP review.

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)

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 the document status, the PO, vendor, amount, etc may be added to the documents title.

Returns:

- Customized document title text dependent upon route level.

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<CreditMemoItem> 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 PurchasingAccountsPayableDocument 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()

getLineItemPreTaxTotal

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

Calculates the pretax total of the above the line items

Returns:

KualiDecimal - above the line item pretax total

getLineItemTotal

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

Calculates the total of the above the line items

Returns:

KualiDecimal - above the line item total

getGrandTotal

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

Calculates the credit memo total: Sum of above the line - restocking fees + misc amount

Specified by:

getGrandTotal in interface AccountsPayableDocument

Specified by:

getGrandTotal in class AccountsPayableDocumentBase

Returns:

KualiDecimal - credit memo document total

See Also:

AccountsPayableDocument.getGrandTotal()

getGrandPreTaxTotal

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

Calculates the credit memo pretax total: Sum of above the line - restocking fees + misc amount

Returns:

KualiDecimal - credit memo document total

getGrandTaxAmount

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

Calculates the credit memo tax amount: Sum of above the line -

Returns:

KualiDecimal - credit memo document total

getGrandPreTaxTotalExcludingRestockingFee

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

getGrandTotalExcludingRestockingFee

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

getPaymentRequestIdentifier

public Integer getPaymentRequestIdentifier()

setPaymentRequestIdentifier

public void setPaymentRequestIdentifier(Integer paymentRequestIdentifier)

getCreditMemoNumber

public String getCreditMemoNumber()

setCreditMemoNumber

public void setCreditMemoNumber(String creditMemoNumber)

getCreditMemoDate

public Date getCreditMemoDate()

setCreditMemoDate

public void setCreditMemoDate(Date creditMemoDate)

getCreditMemoAmount

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

setCreditMemoAmount

public void setCreditMemoAmount(org.kuali.rice.kns.util.KualiDecimal creditMemoAmount)

getItemMiscellaneousCreditDescription

public String getItemMiscellaneousCreditDescription()

setItemMiscellaneousCreditDescription

public void setItemMiscellaneousCreditDescription(String itemMiscellaneousCreditDescription)

getCreditMemoPaidTimestamp

public Timestamp getCreditMemoPaidTimestamp()

setCreditMemoPaidTimestamp

public void setCreditMemoPaidTimestamp(Timestamp creditMemoPaidTimestamp)

getPaymentRequestDocument

public PaymentRequestDocument getPaymentRequestDocument()

setPaymentRequestDocument

public void setPaymentRequestDocument(PaymentRequestDocument paymentRequestDocument)

getPaymentRequest

public PaymentRequestDocument getPaymentRequest()

Deprecated.

AS A REPLACEMENT USE getPaymentRequestDocument()

setPaymentRequest

public void setPaymentRequest(PaymentRequestDocument paymentRequest)

Deprecated.

AS A REPLACEMENT USE setPaymentRequestDocument(PaymentRequestDocument)

getPurchaseOrder

public PurchaseOrderDocument getPurchaseOrder()

Deprecated.

AS A REPLACEMENT USE getPurchaseOrderDocument()

setPurchaseOrder

public void setPurchaseOrder(PurchaseOrderDocument purchaseOrder)

Deprecated.

AS A REPLACEMENT USE setPurchaseOrderDocument(PurchaseOrderDocument)

getPurchaseOrderEndDate

public Date getPurchaseOrderEndDate()

setPurchaseOrderEndDate

public void setPurchaseOrderEndDate(Date purchaseOrderEndDate)

getStatusDescription

public String getStatusDescription()

Deprecated.

USED FOR ROUTING ONLY

setStatusDescription

public void setStatusDescription(String statusDescription)

Deprecated.

USED FOR ROUTING ONLY

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)

Credit Memo document is first populated on Continue AP Event, and then prepareForSave continues.

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

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable,
                                                       GeneralLedgerPendingEntry explicitEntry)

Forces GL entries to be approved before 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)

getTransactionTaxDate

public Date getTransactionTaxDate()

getVendorAttentionName

public String getVendorAttentionName()

Overrides:

getVendorAttentionName in class PurchasingAccountsPayableDocumentBase

setVendorAttentionName

public void setVendorAttentionName(String vendorAttentionName)

Overrides:

setVendorAttentionName in class PurchasingAccountsPayableDocumentBase

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Provides answers to the following splits: RequiresInvoiceAttachment

Specified by:

answerSplitNodeQuestion in interface FinancialSystemTransactionalDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(java.lang.String)

getPaidIndicatorForResult

public String getPaidIndicatorForResult()

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