org.kuali.ole.module.purap.document

Class PurchasingAccountsPayableDocumentBase

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

org.kuali.ole.sys.document.LedgerPostingDocumentBase

org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

org.kuali.ole.sys.document.AccountingDocumentBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AccountsPayableDocumentBase, PurchasingDocumentBase

public abstract class PurchasingAccountsPayableDocumentBase
extends AccountingDocumentBase
implements PurchasingAccountsPayableDocument, AmountTotaling

Base class for Purchasing-Accounts Payable Documents.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accountDistributionMethod
protected List<SourceAccountingLine>	accountsForRouting
protected Integer	accountsPayablePurchasingDocumentLinkIdentifier
boolean	allowDeleteAwareCollection
String[]	belowTheLineTypes
protected boolean	calculated
protected List<PurApItem>	items
protected OleLicensingRequirement	licenseReqmt
protected PurchaseOrderType	orderType
protected Boolean	overrideWorkflowButtons
protected Integer	purapDocumentIdentifier
protected BigDecimal	purchaseOrderTypeId Variable purchaseOrderTypeId added to store order type
protected PurApRelatedViews	relatedViews
protected boolean	sensitive
protected String	statusCode
protected boolean	useTaxIndicator
protected Integer	vendorAddressGeneratedIdentifier
protected String	vendorAddressInternationalProvinceName
protected String	vendorAttentionName
protected String	vendorCityName
protected org.kuali.rice.location.framework.country.CountryEbo	vendorCountry
protected String	vendorCountryCode
protected String	vendorCustomerNumber
protected VendorDetail	vendorDetail
protected Integer	vendorDetailAssignedIdentifier
protected Integer	vendorHeaderGeneratedIdentifier
protected String	vendorLine1Address
protected String	vendorLine2Address
protected String	vendorName
protected String	vendorNumber
protected String	vendorPostalCode
protected String	vendorStateCode

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

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

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

generalLedgerPendingEntries

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

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

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

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

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

documentHeader, documentNumber

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

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
PurchasingAccountsPayableDocumentBase() Default constructor to be overridden.

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(PurApItem item) Adds the specified item to this document.
protected String	buildDocumentTitle(String title) build document title based on the properties of current document
List	buildListOfDeletionAwareLists()
void	customPrepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event) Allows child PO classes to customize the prepareForSave method.
void	deleteItem(int lineNum) Deletes the specified item from this document.
boolean	documentPerformsSufficientFundsCheck() PURAP documents are all overriding this method to return false because sufficient funds checking should not be performed on route of any PURAP documents.
void	fixItemReferences() This method fixes the item references in this document if it's new
String	getAccountDistributionMethod() Gets the accountDistributionMethod attribute.
List<SourceAccountingLine>	getAccountsForRouting()
Integer	getAccountsPayablePurchasingDocumentLinkIdentifier()
protected org.kuali.rice.core.api.util.type.KualiDecimal	getAccountTotalGLEntryAmount(AccountingLine matchingAccountingLine) Helper method to find the matching accountingLines in the list of sourceAccountingLines and sum up the lines amounts.
String[]	getBelowTheLineTypes() Gets all below the line item types.
protected List	getDeletionAwareAccountingLines() Build deletion list of accounting lines for PurAp generic use.
protected GeneralLedgerPendingEntry	getFirstPendingGLEntry()
boolean	getIsATypeOfPODoc() Determines whether the document is a type of PurchseOrderDocument (including its subclass documents).
boolean	getIsATypeOfPurAPRecDoc() Always returns true.
boolean	getIsATypeOfPurDoc() Determines whether the document is a type of PurchasingDocument.
boolean	getIsPODoc() Determines whether the document is a PurchaseOrderDocument (excluding its subclass documents).
boolean	getIsReqsDoc() Determines whether the document is a RequisitionDocument.
PurApItem	getItem(int pos) Gets the item at the specified index.
PurApItem	getItemByItemIdentifier(Integer itemID) Find the item in the document via its identifier.
PurApItem	getItemByLineNumber(int lineNumber) Iterates through the items of the document and returns the item with the line number equal to the number given, or null if a match is not found.
PurApItem	getItemByStringIdentifier(String itemStrID) Find the item in the document via its string identifier.
abstract Class	getItemClass() Returns the Item Class.
int	getItemLinePosition() Determines the item line position if the user did not specify the line number on an above the line items before clicking on the add button.
List	getItems()
abstract Class	getItemUseTaxClass()
String	getLicenseURL() This method returns the licenserequest web service url
boolean	getNeedWarningRelatedPOs() Checks whether the related purchase order views need a warning to be displayed, i.e.
org.kuali.rice.krad.util.NoteType	getNoteType()
PurchaseOrderType	getOrderType()
Boolean	getOverrideWorkflowButtons()
protected List	getPersistedSourceAccountingLinesForComparison() Accounting lines that are read-only should skip validation
String	getPostingPeriodCodeFromPendingGLEntries()
Integer	getPostingYearFromPendingGLEntries()
Integer	getPostingYearNextOrCurrent() If posting year on document is set to use NEXT fiscal year, then return NEXT.
Integer	getPurapDocumentIdentifier()
abstract PurchasingAccountsPayableDocument	getPurApSourceDocumentIfPossible() Returns the source of this Purchasing Accounts Payable Document if exists.
abstract String	getPurApSourceDocumentLabelIfPossible() Returns the label of the source of this Purchasing Accounts Payable Document if exists.
BigDecimal	getPurchaseOrderTypeId()
PurApRelatedViews	getRelatedViews()
List	getSourceAccountingLines() Overridden to return the source lines of all of the items
protected List	getSourceAccountingLinesForComparison() Accounting lines that are read-only should skip validation
String	getStatusCode() Gets the statusCode attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmount() Since one side of the document should match the other and the document should balance, the total dollar amount for the document should either be the expense line or the income line.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmountAboveLineItems() Computes the total dollar amount of all above the line items.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmountAboveLineItems(String[] excludedTypes) Computes the total dollar amount of all above the line items with the specified item types excluded.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmountAllItems(String[] excludedTypes) Computes the total dollar amount with the specified item types excluded.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmountForTradeIn()
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmountWithExclusions(String[] excludedTypes, boolean includeBelowTheLine) Computes the total dollar amount with the specified item types and possibly below the line items excluded.
protected org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmountWithExclusionsSubsetItems(String[] excludedTypes, boolean includeBelowTheLine, List<PurApItem> itemsForTotal) This method...
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalPreTaxDollarAmount() Computes the pre tax total dollar amount of all items.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalPreTaxDollarAmountAboveLineItems() Computes the total dollar amount of all above the line items.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalPreTaxDollarAmountAboveLineItems(String[] excludedTypes) Computes the total dollar amount of all above the line items with the specified item types excluded.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalPreTaxDollarAmountAllItems(String[] excludedTypes) Computes the pre tax total dollar amount with the specified item types excluded.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalPreTaxDollarAmountWithExclusions(String[] excludedTypes, boolean includeBelowTheLine) Computes the total dollar amount with the specified item types and possibly below the line items excluded.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalTaxAmount()
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalTaxAmountAboveLineItems()
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalTaxAmountAboveLineItems(String[] excludedTypes)
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalTaxAmountAllItems(String[] excludedTypes)
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalTaxAmountWithExclusions(String[] excludedTypes, boolean includeBelowTheLine)
PurApItem	getTradeInItem() Returns the trade in item of the document.
List<PurApItem>	getTradeInItems() This method...
Integer	getVendorAddressGeneratedIdentifier()
String	getVendorAddressInternationalProvinceName()
String	getVendorAttentionName()
String	getVendorCityName()
org.kuali.rice.location.framework.country.CountryEbo	getVendorCountry()
String	getVendorCountryCode()
String	getVendorCustomerNumber()
VendorDetail	getVendorDetail()
Integer	getVendorDetailAssignedIdentifier()
Integer	getVendorHeaderGeneratedIdentifier()
String	getVendorLine1Address()
String	getVendorLine2Address()
String	getVendorName()
String	getVendorNumber() Returns the vendor number for this document.
String	getVendorPostalCode()
String	getVendorStateCode()
boolean	isCalculated() Gets the calculated attribute.
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) Determines whether the account is debit.
boolean	isDocumentStoppedInRouteNode(String nodeName) Returns true if this document is stopped in the specified route node.
protected boolean	isDuplicateAccountingLine(List<AccountingLine> sourceAccountingLines, PurApAccountingLine accountingLine) Helper method to check if the source accounting line is already in the list and if so return true
boolean	isInquiryRendered() Determines whether the inquiry links should be rendered for Object Code and Sub Object Code.
boolean	isPostingYearNext() Returns true if posting year on document is set to use NEXT fiscal year.
boolean	isPostingYearPrior() Returns true if posting year on document is set to use PRIOR fiscal year.
boolean	isSensitive()
boolean	isUseTaxIndicator()
void	itemSwap(int positionFrom, int positionTo) Swaps the specified two items based on their item line numbers (which are one higher than the item positions in the list).
protected void	logAndThrowRuntimeException(String errorMessage) Records the specified error message into the Log file and throws a runtime exception.
protected void	logAndThrowRuntimeException(String errorMessage, Exception e) Records the specified error message into the Log file and throws the specified runtime exception.
protected void	populateAccountsForRouting() Makes sure that accounts for routing has been generated, so that other information can be retrieved from that
void	prepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	processAfterRetrieve() This is the default implementation which ensures that document note attachment references are loaded.
void	refreshNonUpdateableReferences()
void	renumberItems(int start) Renumbers the item starting from the specified index.
void	setAccountDistributionMethod(String accountDistributionMethod) Sets the accountDistributionMethod attribute.
void	setAccountsForRouting(List<SourceAccountingLine> accountsForRouting)
void	setAccountsPayablePurchasingDocumentLinkIdentifier(Integer accountsPayablePurchasingDocumentLinkIdentifier)
void	setCalculated(boolean calculated) Sets the calculated attribute.
void	setItems(List items)
void	setOleUrlResolver(OleUrlResolver oleUrlResolver)
void	setOrderType(PurchaseOrderType orderType)
void	setOverrideWorkflowButtons(Boolean overrideWorkflowButtons)
void	setPostingYear(Integer postingYear) Overriding the parent method so that we can just set the posting year without the other stuff that the parent does to the accounting period.
void	setPurapDocumentIdentifier(Integer identifier)
void	setPurchaseOrderTypeId(BigDecimal purchaseOrderTypeId)
void	setPurchaseOrderTypeId(String purchaseOrderType)
void	setRelatedViews(PurApRelatedViews relatedViews)
void	setStatusCode(String statusCode) Sets the statusCode attribute.
void	setTotalDollarAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount) Sets the total dollar amount to the specified amount.
void	setTotalPreTaxDollarAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount) Sets the pre tax total dollar amount to the specified amount.
void	setTotalTaxAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount)
void	setUseTaxIndicator(boolean useTaxIndicator)
void	setVendorAddressGeneratedIdentifier(Integer vendorAddressGeneratedIdentifier)
void	setVendorAddressInternationalProvinceName(String vendorAddressInternationalProvinceName)
void	setVendorAttentionName(String vendorAttentionName)
void	setVendorCityName(String vendorCityName)
void	setVendorCountry(org.kuali.rice.location.framework.country.CountryEbo vendorCountry) Deprecated.
void	setVendorCountryCode(String vendorCountryCode)
void	setVendorCustomerNumber(String vendorCustomerNumber)
void	setVendorDetail(VendorDetail vendorDetail)
void	setVendorDetailAssignedIdentifier(Integer vendorDetailAssignedIdentifier)
void	setVendorHeaderGeneratedIdentifier(Integer vendorHeaderGeneratedIdentifier)
void	setVendorLine1Address(String vendorLine1Address)
void	setVendorLine2Address(String vendorLine2Address)
void	setVendorName(String vendorName)
void	setVendorNumber(String vendorNumber)
void	setVendorPostalCode(String vendorPostalCode)
void	setVendorStateCode(String vendorStateCode)
void	templateVendorAddress(VendorAddress vendorAddress) Sets vendor address fields based on a given VendorAddress.

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

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

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

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

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

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

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

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

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

getAllowsCopy, isSessionDocument

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

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

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

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

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

toString

Methods inherited from class java.lang.Object

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

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

getApplicationDocumentStatus, getTransactionTaxDate, setApplicationDocumentStatus, shouldGiveErrorForEmptyAccountsProration

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

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

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

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

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

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode

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

answerSplitNodeQuestion, getFinancialSystemDocumentHeader

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

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

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

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

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

refresh

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

toString

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

getVersionNumber

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

getObjectId

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

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

Field Detail

purapDocumentIdentifier

protected Integer purapDocumentIdentifier

vendorHeaderGeneratedIdentifier

protected Integer vendorHeaderGeneratedIdentifier

vendorDetailAssignedIdentifier

protected Integer vendorDetailAssignedIdentifier

vendorCustomerNumber

protected String vendorCustomerNumber

vendorName

protected String vendorName

vendorLine1Address

protected String vendorLine1Address

vendorLine2Address

protected String vendorLine2Address

vendorCityName

protected String vendorCityName

vendorStateCode

protected String vendorStateCode

vendorAddressInternationalProvinceName

protected String vendorAddressInternationalProvinceName

vendorPostalCode

protected String vendorPostalCode

vendorCountryCode

protected String vendorCountryCode

accountsPayablePurchasingDocumentLinkIdentifier

protected Integer accountsPayablePurchasingDocumentLinkIdentifier

useTaxIndicator

protected boolean useTaxIndicator

vendorAttentionName

protected String vendorAttentionName

accountDistributionMethod

protected String accountDistributionMethod

purchaseOrderTypeId

protected BigDecimal purchaseOrderTypeId

Variable purchaseOrderTypeId added to store order type

statusCode

protected String statusCode

vendorNumber

protected String vendorNumber

vendorAddressGeneratedIdentifier

protected Integer vendorAddressGeneratedIdentifier

overrideWorkflowButtons

protected Boolean overrideWorkflowButtons

relatedViews

protected transient PurApRelatedViews relatedViews

sensitive

protected boolean sensitive

calculated

protected boolean calculated

items

protected List<PurApItem> items

accountsForRouting

protected List<SourceAccountingLine> accountsForRouting

vendorDetail

protected VendorDetail vendorDetail

vendorCountry

protected org.kuali.rice.location.framework.country.CountryEbo vendorCountry

orderType

protected PurchaseOrderType orderType

licenseReqmt

protected OleLicensingRequirement licenseReqmt

belowTheLineTypes

public transient String[] belowTheLineTypes

allowDeleteAwareCollection

public boolean allowDeleteAwareCollection

Constructor Detail

PurchasingAccountsPayableDocumentBase

public PurchasingAccountsPayableDocumentBase()

Default constructor to be overridden.

Method Detail

getFirstPendingGLEntry

protected GeneralLedgerPendingEntry getFirstPendingGLEntry()

getPostingYearFromPendingGLEntries

public Integer getPostingYearFromPendingGLEntries()

getPostingPeriodCodeFromPendingGLEntries

public String getPostingPeriodCodeFromPendingGLEntries()

getAccountsForRouting

public List<SourceAccountingLine> getAccountsForRouting()

setAccountsForRouting

public void setAccountsForRouting(List<SourceAccountingLine> accountsForRouting)

populateAccountsForRouting

protected void populateAccountsForRouting()

Makes sure that accounts for routing has been generated, so that other information can be retrieved from that

isSensitive

public boolean isSensitive()

isInquiryRendered

public boolean isInquiryRendered()

Description copied from interface: PurchasingAccountsPayableDocument

Determines whether the inquiry links should be rendered for Object Code and Sub Object Code.

Specified by:

isInquiryRendered in interface PurchasingAccountsPayableDocument

Returns:

See Also:

PurchasingAccountsPayableDocument.isInquiryRendered()

isPostingYearNext

public boolean isPostingYearNext()

Description copied from interface: PurchasingAccountsPayableDocument

Returns true if posting year on document is set to use NEXT fiscal year. If set to anything besides NEXT, then return false.

Specified by:

isPostingYearNext in interface PurchasingAccountsPayableDocument

Returns:

boolean

See Also:

PurchasingAccountsPayableDocument.isPostingYearNext()

isPostingYearPrior

public boolean isPostingYearPrior()

Description copied from interface: PurchasingAccountsPayableDocument

Returns true if posting year on document is set to use PRIOR fiscal year. If set to anything besides PRIOR, then return false.

Specified by:

isPostingYearPrior in interface PurchasingAccountsPayableDocument

Returns:

boolean

See Also:

PurchasingAccountsPayableDocument.isPostingYearPrior()

getPostingYearNextOrCurrent

public Integer getPostingYearNextOrCurrent()

Description copied from interface: PurchasingAccountsPayableDocument

If posting year on document is set to use NEXT fiscal year, then return NEXT. If set to anything besides NEXT, then return CURRENT fiscal year. This is assuming that the system does not allow the user to set a posting year beyond NEXT.

Specified by:

getPostingYearNextOrCurrent in interface PurchasingAccountsPayableDocument

Returns:

Integer

See Also:

PurchasingAccountsPayableDocument.getPostingYearNextOrCurrent()

getItemClass

public abstract Class getItemClass()

Description copied from interface: PurchasingAccountsPayableDocument

Returns the Item Class.

Specified by:

getItemClass in interface PurapItemOperations

Specified by:

getItemClass in interface PurchasingAccountsPayableDocument

Returns:

the Item Class.

See Also:

PurchasingAccountsPayableDocument.getItemClass()

getItemUseTaxClass

public abstract Class getItemUseTaxClass()

getPurApSourceDocumentIfPossible

public abstract PurchasingAccountsPayableDocument getPurApSourceDocumentIfPossible()

Description copied from interface: PurchasingAccountsPayableDocument

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

Specified by:

getPurApSourceDocumentIfPossible in interface PurchasingAccountsPayableDocument

Returns:

the source of this document if exists, else null.

See Also:

PurchasingAccountsPayableDocument.getPurApSourceDocumentIfPossible()

getPurApSourceDocumentLabelIfPossible

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

Returns:

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

See Also:

PurchasingAccountsPayableDocument.getPurApSourceDocumentLabelIfPossible()

prepareForSave

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

Specified by:

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

Overrides:

prepareForSave in class AccountingDocumentBase

See Also:

DocumentBase.prepareForSave()

documentPerformsSufficientFundsCheck

public boolean documentPerformsSufficientFundsCheck()

PURAP documents are all overriding this method to return false because sufficient funds checking should not be performed on route of any PURAP documents. Only the Purchase Order performs a sufficient funds check and it is manually forced during routing.

Overrides:

documentPerformsSufficientFundsCheck in class GeneralLedgerPostingDocumentBase

Returns:

See Also:

GeneralLedgerPostingDocumentBase.documentPerformsSufficientFundsCheck()

isDocumentStoppedInRouteNode

public boolean isDocumentStoppedInRouteNode(String nodeName)

Description copied from interface: PurchasingAccountsPayableDocument

Returns true if this document is stopped in the specified route node.

Specified by:

isDocumentStoppedInRouteNode in interface PurchasingAccountsPayableDocument

Returns:

true if this document is stopped in the specified route node.

logAndThrowRuntimeException

protected void logAndThrowRuntimeException(String errorMessage)

Records the specified error message into the Log file and throws a runtime exception.

Parameters:

errorMessage - the error message to be logged.

logAndThrowRuntimeException

protected void logAndThrowRuntimeException(String errorMessage,
                               Exception e)

Records the specified error message into the Log file and throws the specified runtime exception.

Parameters:

errorMessage - the specified error message.

e - the specified runtime exception.

customPrepareForSave

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

Allows child PO classes to customize the prepareForSave method. Most of the subclasses need to call the super's method to get the GL entry creation, but they each need to do different things to prepare for those entries to be created. This is only for PO since it has children classes that need different prep work for GL creation.

Parameters:

event - the event involved in this action.

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class AccountingDocumentBase

See Also:

AccountingDocumentBase.buildListOfDeletionAwareLists()

getDeletionAwareAccountingLines

protected List getDeletionAwareAccountingLines()

Build deletion list of accounting lines for PurAp generic use.

Returns:

processAfterRetrieve

public void processAfterRetrieve()

Description copied from class: FinancialSystemTransactionalDocumentBase

This is the default implementation which ensures that document note attachment references are loaded.

Specified by:

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

Overrides:

processAfterRetrieve in class FinancialSystemTransactionalDocumentBase

See Also:

AccountingDocumentBase.buildListOfDeletionAwareLists()

addItem

public void addItem(PurApItem item)

Description copied from interface: PurchasingAccountsPayableDocument

Adds the specified item to this document.

Specified by:

addItem in interface PurchasingAccountsPayableDocument

Parameters:

item - the specified item to add.

See Also:

PurchasingAccountsPayableDocument.addItem(PurApItem item)

deleteItem

public void deleteItem(int lineNum)

Description copied from interface: PurchasingAccountsPayableDocument

Deletes the specified item from this document.

Specified by:

deleteItem in interface PurchasingAccountsPayableDocument

See Also:

PurchasingAccountsPayableDocument.deleteItem(int lineNum)

renumberItems

public void renumberItems(int start)

Description copied from interface: PurchasingAccountsPayableDocument

Renumbers the item starting from the specified index.

Specified by:

renumberItems in interface PurchasingAccountsPayableDocument

Parameters:

start - the index of the starting item to be renumbered.

See Also:

PurchasingAccountsPayableDocument.renumberItems(int start)

itemSwap

public void itemSwap(int positionFrom,
            int positionTo)

Description copied from interface: PurchasingAccountsPayableDocument

Swaps the specified two items based on their item line numbers (which are one higher than the item positions in the list).

Specified by:

itemSwap in interface PurchasingAccountsPayableDocument

Parameters:

positionFrom - the position of the first item

positionTo - the position of the second item

See Also:

PurchasingAccountsPayableDocument.itemSwap(int positionFrom, int positionTo)

getItemLinePosition

public int getItemLinePosition()

Description copied from interface: PurchasingAccountsPayableDocument

Determines the item line position if the user did not specify the line number on an above the line items before clicking on the add button. It subtracts the number of the below the line items on the list with the total item list size.

Specified by:

getItemLinePosition in interface PurchasingAccountsPayableDocument

Returns:

the item line position of the last (highest) line number of above the line items.

See Also:

PurchasingAccountsPayableDocument.getItemLinePosition()

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

Parameters:

pos - the specified index.

Returns:

the item at the specified index.

See Also:

PurchasingAccountsPayableDocument.getItem(int pos)

getItemByLineNumber

public PurApItem getItemByLineNumber(int lineNumber)

Iterates through the items of the document and returns the item with the line number equal to the number given, or null if a match is not found.

Parameters:

lineNumber - line number to match on.

Returns:

the PurchasingAp Item if a match is found, else null.

getItemByStringIdentifier

public PurApItem getItemByStringIdentifier(String itemStrID)

Find the item in the document via its string identifier.

Parameters:

itemStrID - the string identifier of the item being searched for

Returns:

the item being searched for

getItemByItemIdentifier

public PurApItem getItemByItemIdentifier(Integer itemID)

Find the item in the document via its identifier.

Parameters:

itemID - the string identifier of the item being searched for

Returns:

the item being searched for

setPostingYear

public void setPostingYear(Integer postingYear)

Overriding the parent method so that we can just set the posting year without the other stuff that the parent does to the accounting period. We only store the posting year on the doc and don't want the other stuff.

Specified by:

setPostingYear in interface LedgerPostingDocument

Overrides:

setPostingYear in class LedgerPostingDocumentBase

See Also:

LedgerPostingDocumentBase.setPostingYear(java.lang.Integer)

getTotalDollarAmount

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

Description copied from class: AccountingDocumentBase

Since one side of the document should match the other and the document should balance, the total dollar amount for the document should either be the expense line or the income line. This is the default implementation of this interface method so it should be overridden appropriately if your document cannot make this assumption.

Specified by:

getTotalDollarAmount in interface PurchasingAccountsPayableDocument

Specified by:

getTotalDollarAmount in interface AmountTotaling

Overrides:

getTotalDollarAmount in class AccountingDocumentBase

Returns:

if target total is zero, source total, otherwise target total

See Also:

AccountingDocumentBase.getTotalDollarAmount()

setTotalDollarAmount

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

Description copied from interface: PurchasingAccountsPayableDocument

Sets the total dollar amount to the specified amount.

Specified by:

setTotalDollarAmount in interface PurchasingAccountsPayableDocument

See Also:

PurchasingAccountsPayableDocument.setTotalDollarAmount(KualiDecimal amount)

getTotalDollarAmountAllItems

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmountAllItems(String[] excludedTypes)

Description copied from interface: PurchasingAccountsPayableDocument

Computes the total dollar amount with the specified item types excluded.

Specified by:

getTotalDollarAmountAllItems in interface PurchasingAccountsPayableDocument

Parameters:

excludedTypes - the types of items to be excluded.

Returns:

the total dollar amount with the specified item types excluded.

See Also:

PurchasingAccountsPayableDocument.getTotalDollarAmountAllItems(String[] excludedTypes)

getTotalDollarAmountAboveLineItems

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

Computes the total dollar amount of all above the line items.

Specified by:

getTotalDollarAmountAboveLineItems in interface PurchasingAccountsPayableDocument

Returns:

the total dollar amount of all above the line items.

getTotalDollarAmountAboveLineItems

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmountAboveLineItems(String[] excludedTypes)

Computes the total dollar amount of all above the line items with the specified item types excluded.

Parameters:

excludedTypes - the types of items to be excluded.

Returns:

the total dollar amount of all above the line items with the specified item types excluded..

getTotalDollarAmountWithExclusions

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmountWithExclusions(String[] excludedTypes,
                                                                                boolean includeBelowTheLine)

Computes the total dollar amount with the specified item types and possibly below the line items excluded.

Parameters:

excludedTypes - the types of items to be excluded.

includeBelowTheLine - indicates whether below the line items shall be included.

Returns:

the total dollar amount with the specified item types excluded.

getTotalDollarAmountWithExclusionsSubsetItems

protected org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmountWithExclusionsSubsetItems(String[] excludedTypes,
                                                                                           boolean includeBelowTheLine,
                                                                                           List<PurApItem> itemsForTotal)

This method...

Parameters:

excludedTypes -

includeBelowTheLine -

itemsForTotal -

Returns:

getTotalDollarAmountForTradeIn

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

Specified by:

getTotalDollarAmountForTradeIn in interface PurchasingAccountsPayableDocument

getTradeInItems

public List<PurApItem> getTradeInItems()

This method...

Specified by:

getTradeInItems in interface PurchasingAccountsPayableDocument

Parameters:

tradeInItems -

getTotalPreTaxDollarAmount

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

Description copied from interface: PurchasingAccountsPayableDocument

Computes the pre tax total dollar amount of all items.

Specified by:

getTotalPreTaxDollarAmount in interface PurchasingAccountsPayableDocument

Returns:

the pre tax total dollar amount of all items.

See Also:

PurchasingAccountsPayableDocument.getTotalPreTaxDollarAmount()

setTotalPreTaxDollarAmount

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

Description copied from interface: PurchasingAccountsPayableDocument

Sets the pre tax total dollar amount to the specified amount.

Specified by:

setTotalPreTaxDollarAmount in interface PurchasingAccountsPayableDocument

See Also:

org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument#setTotalPreTaxDollarAmount(org.kuali.rice.kns.util.KualiDecimal)

getTotalPreTaxDollarAmountAllItems

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalPreTaxDollarAmountAllItems(String[] excludedTypes)

Description copied from interface: PurchasingAccountsPayableDocument

Computes the pre tax total dollar amount with the specified item types excluded.

Specified by:

getTotalPreTaxDollarAmountAllItems in interface PurchasingAccountsPayableDocument

Parameters:

excludedTypes - the types of items to be excluded.

Returns:

the pre tax total dollar amount with the specified item types excluded.

See Also:

PurchasingAccountsPayableDocument.getTotalPreTaxDollarAmountAllItems(java.lang.String[])

getTotalPreTaxDollarAmountAboveLineItems

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

Computes the total dollar amount of all above the line items.

Returns:

the total dollar amount of all above the line items.

getTotalPreTaxDollarAmountAboveLineItems

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalPreTaxDollarAmountAboveLineItems(String[] excludedTypes)

Computes the total dollar amount of all above the line items with the specified item types excluded.

Parameters:

excludedTypes - the types of items to be excluded.

Returns:

the total dollar amount of all above the line items with the specified item types excluded..

getTotalPreTaxDollarAmountWithExclusions

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalPreTaxDollarAmountWithExclusions(String[] excludedTypes,
                                                                                      boolean includeBelowTheLine)

Computes the total dollar amount with the specified item types and possibly below the line items excluded.

Parameters:

excludedTypes - the types of items to be excluded.

includeBelowTheLine - indicates whether below the line items shall be included.

Returns:

the total dollar amount with the specified item types excluded.

getTotalTaxAmount

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

Specified by:

getTotalTaxAmount in interface PurchasingAccountsPayableDocument

setTotalTaxAmount

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

Specified by:

setTotalTaxAmount in interface PurchasingAccountsPayableDocument

getTotalTaxAmountAllItems

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalTaxAmountAllItems(String[] excludedTypes)

Specified by:

getTotalTaxAmountAllItems in interface PurchasingAccountsPayableDocument

getTotalTaxAmountAboveLineItems

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

Specified by:

getTotalTaxAmountAboveLineItems in interface PurchasingAccountsPayableDocument

getTotalTaxAmountAboveLineItems

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalTaxAmountAboveLineItems(String[] excludedTypes)

Specified by:

getTotalTaxAmountAboveLineItems in interface PurchasingAccountsPayableDocument

getTotalTaxAmountWithExclusions

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalTaxAmountWithExclusions(String[] excludedTypes,
                                                                             boolean includeBelowTheLine)

Specified by:

getTotalTaxAmountWithExclusions in interface PurchasingAccountsPayableDocument

isUseTaxIndicator

public boolean isUseTaxIndicator()

Specified by:

isUseTaxIndicator in interface PurchasingAccountsPayableDocument

setUseTaxIndicator

public void setUseTaxIndicator(boolean useTaxIndicator)

Specified by:

setUseTaxIndicator in interface PurchasingAccountsPayableDocument

templateVendorAddress

public void templateVendorAddress(VendorAddress vendorAddress)

Description copied from interface: PurchasingAccountsPayableDocument

Sets vendor address fields based on a given VendorAddress.

Specified by:

templateVendorAddress in interface PurchasingAccountsPayableDocument

See Also:

PurchasingAccountsPayableDocument.templateVendorAddress(VendorAddress)

getVendorNumber

public String getVendorNumber()

Returns the vendor number for this document.

Specified by:

getVendorNumber in interface PurchasingAccountsPayableDocument

Returns:

the vendor number for this document.

See Also:

PurchasingAccountsPayableDocument.getVendorNumber()

setVendorNumber

public void setVendorNumber(String vendorNumber)

Specified by:

setVendorNumber in interface PurchasingAccountsPayableDocument

getOverrideWorkflowButtons

public Boolean getOverrideWorkflowButtons()

setOverrideWorkflowButtons

public void setOverrideWorkflowButtons(Boolean overrideWorkflowButtons)

getVendorHeaderGeneratedIdentifier

public Integer getVendorHeaderGeneratedIdentifier()

Specified by:

getVendorHeaderGeneratedIdentifier in interface PurchasingAccountsPayableDocument

setVendorHeaderGeneratedIdentifier

public void setVendorHeaderGeneratedIdentifier(Integer vendorHeaderGeneratedIdentifier)

Specified by:

setVendorHeaderGeneratedIdentifier in interface PurchasingAccountsPayableDocument

getVendorDetailAssignedIdentifier

public Integer getVendorDetailAssignedIdentifier()

Specified by:

getVendorDetailAssignedIdentifier in interface PurchasingAccountsPayableDocument

setVendorDetailAssignedIdentifier

public void setVendorDetailAssignedIdentifier(Integer vendorDetailAssignedIdentifier)

Specified by:

setVendorDetailAssignedIdentifier in interface PurchasingAccountsPayableDocument

getVendorCustomerNumber

public String getVendorCustomerNumber()

Specified by:

getVendorCustomerNumber in interface PurchasingAccountsPayableDocument

setVendorCustomerNumber

public void setVendorCustomerNumber(String vendorCustomerNumber)

Specified by:

setVendorCustomerNumber in interface PurchasingAccountsPayableDocument

getPurapDocumentIdentifier

public Integer getPurapDocumentIdentifier()

Specified by:

getPurapDocumentIdentifier in interface PurchasingAccountsPayableDocument

setPurapDocumentIdentifier

public void setPurapDocumentIdentifier(Integer identifier)

Specified by:

setPurapDocumentIdentifier in interface PurchasingAccountsPayableDocument

getVendorDetail

public VendorDetail getVendorDetail()

Specified by:

getVendorDetail in interface PurchasingAccountsPayableDocument

setVendorDetail

public void setVendorDetail(VendorDetail vendorDetail)

getItems

public List getItems()

Specified by:

getItems in interface PurapItemOperations

Specified by:

getItems in interface PurchasingAccountsPayableDocument

setItems

public void setItems(List items)

Specified by:

setItems in interface PurapItemOperations

Specified by:

setItems in interface PurchasingAccountsPayableDocument

getVendorCityName

public String getVendorCityName()

Specified by:

getVendorCityName in interface PurchasingAccountsPayableDocument

setVendorCityName

public void setVendorCityName(String vendorCityName)

Specified by:

setVendorCityName in interface PurchasingAccountsPayableDocument

getVendorCountryCode

public String getVendorCountryCode()

Specified by:

getVendorCountryCode in interface PurchasingAccountsPayableDocument

setVendorCountryCode

public void setVendorCountryCode(String vendorCountryCode)

Specified by:

setVendorCountryCode in interface PurchasingAccountsPayableDocument

getVendorLine1Address

public String getVendorLine1Address()

Specified by:

getVendorLine1Address in interface PurchasingAccountsPayableDocument

setVendorLine1Address

public void setVendorLine1Address(String vendorLine1Address)

Specified by:

setVendorLine1Address in interface PurchasingAccountsPayableDocument

getVendorLine2Address

public String getVendorLine2Address()

Specified by:

getVendorLine2Address in interface PurchasingAccountsPayableDocument

setVendorLine2Address

public void setVendorLine2Address(String vendorLine2Address)

Specified by:

setVendorLine2Address in interface PurchasingAccountsPayableDocument

getVendorName

public String getVendorName()

Specified by:

getVendorName in interface PurchasingAccountsPayableDocument

setVendorName

public void setVendorName(String vendorName)

Specified by:

setVendorName in interface PurchasingAccountsPayableDocument

getVendorPostalCode

public String getVendorPostalCode()

Specified by:

getVendorPostalCode in interface PurchasingAccountsPayableDocument

setVendorPostalCode

public void setVendorPostalCode(String vendorPostalCode)

Specified by:

setVendorPostalCode in interface PurchasingAccountsPayableDocument

getVendorStateCode

public String getVendorStateCode()

Specified by:

getVendorStateCode in interface PurchasingAccountsPayableDocument

setVendorStateCode

public void setVendorStateCode(String vendorStateCode)

Specified by:

setVendorStateCode in interface PurchasingAccountsPayableDocument

getVendorAddressInternationalProvinceName

public String getVendorAddressInternationalProvinceName()

Specified by:

getVendorAddressInternationalProvinceName in interface PurchasingAccountsPayableDocument

setVendorAddressInternationalProvinceName

public void setVendorAddressInternationalProvinceName(String vendorAddressInternationalProvinceName)

Specified by:

setVendorAddressInternationalProvinceName in interface PurchasingAccountsPayableDocument

getVendorAddressGeneratedIdentifier

public Integer getVendorAddressGeneratedIdentifier()

Specified by:

getVendorAddressGeneratedIdentifier in interface PurchasingAccountsPayableDocument

setVendorAddressGeneratedIdentifier

public void setVendorAddressGeneratedIdentifier(Integer vendorAddressGeneratedIdentifier)

Specified by:

setVendorAddressGeneratedIdentifier in interface PurchasingAccountsPayableDocument

getAccountsPayablePurchasingDocumentLinkIdentifier

public Integer getAccountsPayablePurchasingDocumentLinkIdentifier()

Specified by:

getAccountsPayablePurchasingDocumentLinkIdentifier in interface PurchasingAccountsPayableDocument

setAccountsPayablePurchasingDocumentLinkIdentifier

public void setAccountsPayablePurchasingDocumentLinkIdentifier(Integer accountsPayablePurchasingDocumentLinkIdentifier)

Specified by:

setAccountsPayablePurchasingDocumentLinkIdentifier in interface PurchasingAccountsPayableDocument

getBelowTheLineTypes

public String[] getBelowTheLineTypes()

Description copied from interface: PurchasingAccountsPayableDocument

Gets all below the line item types.

Specified by:

getBelowTheLineTypes in interface PurchasingAccountsPayableDocument

Returns:

Returns a list of below the line item types.

getVendorCountry

public org.kuali.rice.location.framework.country.CountryEbo getVendorCountry()

Specified by:

getVendorCountry in interface PurchasingAccountsPayableDocument

setVendorCountry

@Deprecated
public void setVendorCountry(org.kuali.rice.location.framework.country.CountryEbo vendorCountry)

Deprecated.

Added only to allow for PurApObjectUtils class to work correctly.

getVendorAttentionName

public String getVendorAttentionName()

setVendorAttentionName

public void setVendorAttentionName(String vendorAttentionName)

getAccountDistributionMethod

public String getAccountDistributionMethod()

Gets the accountDistributionMethod attribute.

Returns:

Returns the accountDistributionMethod

setAccountDistributionMethod

public void setAccountDistributionMethod(String accountDistributionMethod)

Sets the accountDistributionMethod attribute.

Parameters:

accountDistributionMethod - The accountDistributionMethod to set.

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

Determines whether the account is debit. It always returns false.

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Specified by:

isDebit in class AccountingDocumentBase

Parameters:

financialDocument - The document containing the account to be validated.

accountingLine - The account to be validated.

Returns:

boolean false.

See Also:

org.kuali.ole.sys.document.validation.AccountingLineRule#isDebit(org.kuali.ole.sys.document.AccountingDocument, org.kuali.ole.sys.businessobject.AccountingLine)

getRelatedViews

public PurApRelatedViews getRelatedViews()

setRelatedViews

public void setRelatedViews(PurApRelatedViews relatedViews)

refreshNonUpdateableReferences

public void refreshNonUpdateableReferences()

Specified by:

refreshNonUpdateableReferences in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

refreshNonUpdateableReferences in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

fixItemReferences

public void fixItemReferences()

This method fixes the item references in this document if it's new

Specified by:

fixItemReferences in interface PurchasingAccountsPayableDocument

getTradeInItem

public PurApItem getTradeInItem()

Returns the trade in item of the document.

Specified by:

getTradeInItem in interface PurchasingAccountsPayableDocument

Returns:

getIsATypeOfPurAPRecDoc

public boolean getIsATypeOfPurAPRecDoc()

Description copied from interface: PurchasingAccountsPayableDocument

Always returns true. This method is needed here because it's called by some tag files shared with PurAp documents.

Specified by:

getIsATypeOfPurAPRecDoc in interface PurchasingAccountsPayableDocument

Returns:

true.

See Also:

org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument.getIsATypeOfPurAPRecDoc().

getIsATypeOfPurDoc

public boolean getIsATypeOfPurDoc()

Description copied from interface: PurchasingAccountsPayableDocument

Determines whether the document is a type of PurchasingDocument.

Specified by:

getIsATypeOfPurDoc in interface PurchasingAccountsPayableDocument

Returns:

true if the document is a type of PurchasingDocument.

See Also:

org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument.getIsATypeOfPurDoc().

getIsATypeOfPODoc

public boolean getIsATypeOfPODoc()

Description copied from interface: PurchasingAccountsPayableDocument

Determines whether the document is a type of PurchseOrderDocument (including its subclass documents).

Specified by:

getIsATypeOfPODoc in interface PurchasingAccountsPayableDocument

Returns:

true if the document is a type of PurchseOrderDocument.

See Also:

org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument.getIsATypeOfPODoc().

getIsPODoc

public boolean getIsPODoc()

Description copied from interface: PurchasingAccountsPayableDocument

Determines whether the document is a PurchaseOrderDocument (excluding its subclass documents).

Specified by:

getIsPODoc in interface PurchasingAccountsPayableDocument

Returns:

true if the document is a PurchaseOrderDocument.

See Also:

org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument.getIsPODoc().

getIsReqsDoc

public boolean getIsReqsDoc()

Description copied from interface: PurchasingAccountsPayableDocument

Determines whether the document is a RequisitionDocument.

Specified by:

getIsReqsDoc in interface PurchasingAccountsPayableDocument

Returns:

true if the document is a RequisitionDocument.

See Also:

org.kuali.ole.module.purap.document.PurchasingAccountsPayableDocument.getIsATypeOfREQSDoc().

buildDocumentTitle

protected String buildDocumentTitle(String title)

build document title based on the properties of current document

Parameters:

the - default document title

Returns:

the combine information of the given title and additional payment indicators

getSourceAccountingLines

public List getSourceAccountingLines()

Overridden to return the source lines of all of the items

Specified by:

getSourceAccountingLines in interface AccountingDocument

Overrides:

getSourceAccountingLines in class AccountingDocumentBase

Returns:

The list of source accounting lines.

See Also:

AccountingDocumentBase.getSourceAccountingLines()

isDuplicateAccountingLine

protected boolean isDuplicateAccountingLine(List<AccountingLine> sourceAccountingLines,
                                PurApAccountingLine accountingLine)

Helper method to check if the source accounting line is already in the list and if so return true

Parameters:

sourceAccountingLines -

accountingLine -

Returns:

true if it is a duplicate else return false.

getAccountTotalGLEntryAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal getAccountTotalGLEntryAmount(AccountingLine matchingAccountingLine)

Helper method to find the matching accountingLines in the list of sourceAccountingLines and sum up the lines amounts.

Parameters:

accountingLine -

Returns:

accountTotalGLEntryAmount

getNeedWarningRelatedPOs

public boolean getNeedWarningRelatedPOs()

Checks whether the related purchase order views need a warning to be displayed, i.e. if at least one of the purchase orders has never been opened.

Returns:

true if at least one related purchase order needs a warning; false otherwise

getPersistedSourceAccountingLinesForComparison

protected List getPersistedSourceAccountingLinesForComparison()

Accounting lines that are read-only should skip validation

Overrides:

getPersistedSourceAccountingLinesForComparison in class AccountingDocumentBase

Returns:

See Also:

AccountingDocumentBase.getPersistedSourceAccountingLinesForComparison()

getSourceAccountingLinesForComparison

protected List getSourceAccountingLinesForComparison()

Accounting lines that are read-only should skip validation

Overrides:

getSourceAccountingLinesForComparison in class AccountingDocumentBase

Returns:

See Also:

AccountingDocumentBase.getSourceAccountingLinesForComparison()

getStatusCode

public String getStatusCode()

Gets the statusCode attribute.

Returns:

Returns the statusCode

setStatusCode

public void setStatusCode(String statusCode)

Sets the statusCode attribute.

Parameters:

statusCode - The statusCode to set.

isCalculated

public boolean isCalculated()

Gets the calculated attribute.

Specified by:

isCalculated in interface PurchasingAccountsPayableDocument

Returns:

Returns the calculated

setCalculated

public void setCalculated(boolean calculated)

Sets the calculated attribute.

Specified by:

setCalculated in interface PurchasingAccountsPayableDocument

Parameters:

calculated - The calculated to set.

getPurchaseOrderTypeId

public BigDecimal getPurchaseOrderTypeId()

Returns:

setPurchaseOrderTypeId

public void setPurchaseOrderTypeId(BigDecimal purchaseOrderTypeId)

setPurchaseOrderTypeId

public void setPurchaseOrderTypeId(String purchaseOrderType)

getOrderType

public PurchaseOrderType getOrderType()

setOrderType

public void setOrderType(PurchaseOrderType orderType)

getLicenseURL

public String getLicenseURL()

This method returns the licenserequest web service url

Returns:

url

setOleUrlResolver

public void setOleUrlResolver(OleUrlResolver oleUrlResolver)

getNoteType

public org.kuali.rice.krad.util.NoteType getNoteType()

Specified by:

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

Overrides:

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