org.kuali.ole.module.purap.document

Interface PurchasingAccountsPayableDocument

All Superinterfaces:

AccountingDocument, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.document.Document, FinancialSystemDocument, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, LedgerPostingDocument, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.PersistableBusinessObject, PurapItemOperations, Serializable, org.kuali.rice.krad.document.TransactionalDocument, org.kuali.rice.core.api.mo.common.Versioned

All Known Subinterfaces:

AccountsPayableDocument, PurchasingDocument

All Known Implementing Classes:

AccountsPayableDocumentBase, InvoiceDocument, OleInvoiceDocument, OlePaymentRequestDocument, OlePurchaseOrderAmendmentDocument, OlePurchaseOrderCloseDocument, OlePurchaseOrderDocument, OlePurchaseOrderPaymentHoldDocument, OlePurchaseOrderRemoveHoldDocument, OlePurchaseOrderReopenDocument, OlePurchaseOrderRetransmitDocument, OlePurchaseOrderSplitDocument, OlePurchaseOrderVoidDocument, OleRequisitionDocument, OleVendorCreditMemoDocument, PaymentRequestDocument, PurchaseOrderAmendmentDocument, PurchaseOrderCloseDocument, PurchaseOrderDocument, PurchaseOrderPaymentHoldDocument, PurchaseOrderRemoveHoldDocument, PurchaseOrderReopenDocument, PurchaseOrderRetransmitDocument, PurchaseOrderSplitDocument, PurchaseOrderVoidDocument, PurchasingAccountsPayableDocumentBase, PurchasingDocumentBase, RequisitionDocument, VendorCreditMemoDocument

public interface PurchasingAccountsPayableDocument
extends AccountingDocument, PurapItemOperations

Interface for Purchasing-Accounts Payable Documents.

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(PurApItem item) Adds the specified item to this document.
void	deleteItem(int lineNum) Deletes the specified item from this document.
void	fixItemReferences()
Integer	getAccountsPayablePurchasingDocumentLinkIdentifier()
String	getApplicationDocumentStatus()
String[]	getBelowTheLineTypes() Gets all below the line item types.
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.
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<PurApItem>	getItems()
Integer	getPostingYearNextOrCurrent() If posting year on document is set to use NEXT fiscal year, then return NEXT.
Integer	getPurapDocumentIdentifier()
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.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmount() Computes the total dollar amount of all items.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmountAboveLineItems()
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	getTotalPreTaxDollarAmount() Computes the pre tax total dollar amount of all items.
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	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()
List<PurApItem>	getTradeInItems()
Date	getTransactionTaxDate()
Integer	getVendorAddressGeneratedIdentifier()
String	getVendorAddressInternationalProvinceName()
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()
String	getVendorPostalCode()
String	getVendorStateCode()
boolean	isCalculated()
boolean	isDocumentStoppedInRouteNode(String nodeName) Returns true if this document is stopped in the specified route node.
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	isUseTaxIndicator()
void	itemSwap(int position1, int position2) Swaps the specified two items based on their item line numbers (which are one higher than the item positions in the list).
void	renumberItems(int start) Renumbers the item starting from the specified index.
void	setAccountsPayablePurchasingDocumentLinkIdentifier(Integer accountsPayablePurchasingDocumentLinkIdentifier)
void	setApplicationDocumentStatus(String appDocStatus)
void	setCalculated(boolean calculated)
void	setItems(List<PurApItem> items)
void	setPurapDocumentIdentifier(Integer identifier)
void	setTotalDollarAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalDollarAmount) Sets the total dollar amount to the specified amount.
void	setTotalPreTaxDollarAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalDollarAmount) 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	setVendorCityName(String vendorCityName)
void	setVendorCountryCode(String vendorCountryCode)
void	setVendorCustomerNumber(String vendorCustomerNumber)
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)
boolean	shouldGiveErrorForEmptyAccountsProration()
void	templateVendorAddress(VendorAddress vendorAddress) Sets vendor address fields based on a given VendorAddress.

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

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

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

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

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

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

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

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, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

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

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

refresh

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

toString

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

getVersionNumber

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

getObjectId

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

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

Method Detail

isPostingYearNext

boolean isPostingYearNext()

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

Returns:

boolean

isPostingYearPrior

boolean isPostingYearPrior()

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

Returns:

boolean

getPostingYearNextOrCurrent

Integer getPostingYearNextOrCurrent()

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.

Returns:

Integer

getItemClass

Class getItemClass()

Returns the Item Class.

Specified by:

getItemClass in interface PurapItemOperations

Returns:

the Item Class.

getPurApSourceDocumentIfPossible

PurchasingAccountsPayableDocument getPurApSourceDocumentIfPossible()

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

Returns:

the source of this document if exists, else null.

getPurApSourceDocumentLabelIfPossible

String getPurApSourceDocumentLabelIfPossible()

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

Returns:

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

isDocumentStoppedInRouteNode

boolean isDocumentStoppedInRouteNode(String nodeName)

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

Parameters:

nodeDetails - the node details of the specified node.

Returns:

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

addItem

void addItem(PurApItem item)

Adds the specified item to this document.

Parameters:

item - the specified item to add.

deleteItem

void deleteItem(int lineNum)

Deletes the specified item from this document.

Parameters:

item - the specified item to delete.

renumberItems

void renumberItems(int start)

Renumbers the item starting from the specified index.

Parameters:

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

itemSwap

void itemSwap(int position1,
            int position2)

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

Parameters:

position1 - the position of the first item

position2 - the position of the second item

getItemLinePosition

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. It subtracts the number of the below the line items on the list with the total item list size.

Returns:

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

getItem

PurApItem getItem(int pos)

Gets the item at the specified index.

Specified by:

getItem in interface PurapItemOperations

Parameters:

pos - the specified index.

Returns:

the item at the specified index.

getBelowTheLineTypes

String[] getBelowTheLineTypes()

Gets all below the line item types.

Returns:

Returns a list of below the line item types.

getTotalDollarAmount

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

Computes the total dollar amount of all items.

Returns:

the total dollar amount of all items.

setTotalDollarAmount

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

Sets the total dollar amount to the specified amount.

Parameters:

the - specified total amount.

getTotalDollarAmountAllItems

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

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

Parameters:

excludedTypes - the types of items to be excluded.

Returns:

the total dollar amount with the specified item types excluded.

getTotalDollarAmountAboveLineItems

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

getTotalPreTaxDollarAmount

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

Computes the pre tax total dollar amount of all items.

Returns:

the pre tax total dollar amount of all items.

setTotalPreTaxDollarAmount

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

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

Parameters:

the - specified total amount.

getTotalPreTaxDollarAmountAllItems

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

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

Parameters:

excludedTypes - the types of items to be excluded.

Returns:

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

getTotalTaxAmount

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

setTotalTaxAmount

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

getTotalTaxAmountAllItems

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

getTotalTaxAmountAboveLineItems

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

getTotalTaxAmountAboveLineItems

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

getTotalTaxAmountWithExclusions

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

templateVendorAddress

void templateVendorAddress(VendorAddress vendorAddress)

Sets vendor address fields based on a given VendorAddress.

Parameters:

vendorAddress -

getVendorCountry

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

getVendorDetail

VendorDetail getVendorDetail()

getItems

List<PurApItem> getItems()

Specified by:

getItems in interface PurapItemOperations

setItems

void setItems(List<PurApItem> items)

Specified by:

setItems in interface PurapItemOperations

getVendorNumber

String getVendorNumber()

setVendorNumber

void setVendorNumber(String vendorNumber)

getVendorHeaderGeneratedIdentifier

Integer getVendorHeaderGeneratedIdentifier()

setVendorHeaderGeneratedIdentifier

void setVendorHeaderGeneratedIdentifier(Integer vendorHeaderGeneratedIdentifier)

getVendorDetailAssignedIdentifier

Integer getVendorDetailAssignedIdentifier()

setVendorDetailAssignedIdentifier

void setVendorDetailAssignedIdentifier(Integer vendorDetailAssignedIdentifier)

getVendorCustomerNumber

String getVendorCustomerNumber()

setVendorCustomerNumber

void setVendorCustomerNumber(String vendorCustomerNumber)

getPurapDocumentIdentifier

Integer getPurapDocumentIdentifier()

setPurapDocumentIdentifier

void setPurapDocumentIdentifier(Integer identifier)

getApplicationDocumentStatus

String getApplicationDocumentStatus()

setApplicationDocumentStatus

void setApplicationDocumentStatus(String appDocStatus)

getVendorCityName

String getVendorCityName()

setVendorCityName

void setVendorCityName(String vendorCityName)

getVendorCountryCode

String getVendorCountryCode()

setVendorCountryCode

void setVendorCountryCode(String vendorCountryCode)

getVendorLine1Address

String getVendorLine1Address()

setVendorLine1Address

void setVendorLine1Address(String vendorLine1Address)

getVendorLine2Address

String getVendorLine2Address()

setVendorLine2Address

void setVendorLine2Address(String vendorLine2Address)

getVendorName

String getVendorName()

setVendorName

void setVendorName(String vendorName)

getVendorPostalCode

String getVendorPostalCode()

setVendorPostalCode

void setVendorPostalCode(String vendorPostalCode)

getVendorStateCode

String getVendorStateCode()

setVendorStateCode

void setVendorStateCode(String vendorStateCode)

getVendorAddressInternationalProvinceName

String getVendorAddressInternationalProvinceName()

setVendorAddressInternationalProvinceName

void setVendorAddressInternationalProvinceName(String vendorAddressInternationalProvinceName)

getAccountsPayablePurchasingDocumentLinkIdentifier

Integer getAccountsPayablePurchasingDocumentLinkIdentifier()

setAccountsPayablePurchasingDocumentLinkIdentifier

void setAccountsPayablePurchasingDocumentLinkIdentifier(Integer accountsPayablePurchasingDocumentLinkIdentifier)

getVendorAddressGeneratedIdentifier

Integer getVendorAddressGeneratedIdentifier()

setVendorAddressGeneratedIdentifier

void setVendorAddressGeneratedIdentifier(Integer vendorAddressGeneratedIdentifier)

isUseTaxIndicator

boolean isUseTaxIndicator()

setUseTaxIndicator

void setUseTaxIndicator(boolean useTaxIndicator)

fixItemReferences

void fixItemReferences()

getTransactionTaxDate

Date getTransactionTaxDate()

getTradeInItem

PurApItem getTradeInItem()

getTotalDollarAmountForTradeIn

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

getTradeInItems

List<PurApItem> getTradeInItems()

getIsATypeOfPurAPRecDoc

boolean getIsATypeOfPurAPRecDoc()

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

Returns:

true.

getIsATypeOfPurDoc

boolean getIsATypeOfPurDoc()

Determines whether the document is a type of PurchasingDocument.

Returns:

true if the document is a type of PurchasingDocument.

getIsATypeOfPODoc

boolean getIsATypeOfPODoc()

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

Returns:

true if the document is a type of PurchseOrderDocument.

getIsPODoc

boolean getIsPODoc()

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

Returns:

true if the document is a PurchaseOrderDocument.

getIsReqsDoc

boolean getIsReqsDoc()

Determines whether the document is a RequisitionDocument.

Returns:

true if the document is a RequisitionDocument.

isInquiryRendered

boolean isInquiryRendered()

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

Returns:

shouldGiveErrorForEmptyAccountsProration

boolean shouldGiveErrorForEmptyAccountsProration()

isCalculated

boolean isCalculated()

setCalculated

void setCalculated(boolean calculated)