org.kuali.ole.module.purap.businessobject

Class InvoiceItem

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.ole.module.purap.businessobject.PurApItemBase

org.kuali.ole.module.purap.businessobject.AccountsPayableItemBase

org.kuali.ole.module.purap.businessobject.InvoiceItem

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, ExternalPurApItem, AccountsPayableItem, PurapEnterableItem, PurApItem, 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

Direct Known Subclasses:

OleInvoiceItem

public class InvoiceItem
extends AccountsPayableItemBase

Payment Request Item Business Object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	accountsPayablePurchasingDocumentLinkIdentifier
protected boolean	closePurchaseOrderIndicator
protected Integer	poLineNumber
protected Integer	postingYear
protected PurchaseOrderDocument	purchaseOrderDocument
protected boolean	receivingDocumentRequiredIndicator
protected RecurringPaymentType	recurringPaymentType
protected String	recurringPaymentTypeCode
protected boolean	reopenPurchaseOrderIndicator

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

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
InvoiceItem() Default constructor.
InvoiceItem(PurchaseOrderItem poi, InvoiceDocument inv) inv item constructor - Delegate
InvoiceItem(PurchaseOrderItem poi, InvoiceDocument inv, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList) Constructs a new payment request item, but also merges expired accounts.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToExtendedPrice(org.kuali.rice.core.api.util.type.KualiDecimal addThisValue)
void	addToUnitPrice(BigDecimal addThisValue) Added for electronic invoice
void	generateAccountListFromPoItemAccounts(List<PurApAccountingLine> accounts)
Class	getAccountingLineClass()
Integer	getAccountsPayablePurchasingDocumentLinkIdentifier()
InvoiceDocument	getInvoice()
Integer	getInvoiceIdentifier()
org.kuali.rice.core.api.util.type.KualiDecimal	getItemOutstandingInvoiceAmount()
org.kuali.rice.core.api.util.type.KualiDecimal	getItemOutstandingInvoiceQuantity()
BigDecimal	getOriginalAmountfromPO()
PurchaseOrderItem	getPoItem()
Integer	getPoLineNumber()
org.kuali.rice.core.api.util.type.KualiDecimal	getPoOriginalAmount()
org.kuali.rice.core.api.util.type.KualiDecimal	getPoOutstandingAmount()
org.kuali.rice.core.api.util.type.KualiDecimal	getPoOutstandingQuantity()
Integer	getPostingYear()
PurchaseOrderDocument	getPurchaseOrderDocument()
Integer	getPurchaseOrderIdentifier()
PurchaseOrderItem	getPurchaseOrderItem() Retrieves a purchase order item by inspecting the item type to see if its above the line or below the line and returns the appropriate type.
BigDecimal	getPurchaseOrderItemUnitPrice()
RecurringPaymentType	getRecurringPaymentType()
String	getRecurringPaymentTypeCode()
Class	getUseTaxClass()
boolean	isClosePurchaseOrderIndicator()
boolean	isDisplayOnPreq()
boolean	isEnableReceivingDocumentRequiredIndicator() Decides whether receivingDocumentRequiredIndicator functionality shall be enabled according to the controlling parameter.
boolean	isReceivingDocumentRequiredIndicator() Gets the receivingDocumentRequiredIndicator attribute.
boolean	isReopenPurchaseOrderIndicator()
void	resetAccount() sets account line percentage to zero.
void	setAccountsPayablePurchasingDocumentLinkIdentifier(Integer accountsPayablePurchasingDocumentLinkIdentifier)
void	setClosePurchaseOrderIndicator(boolean closePurchaseOrderIndicator)
void	setInvoice(InvoiceDocument invoice)
void	setInvoiceIdentifier(Integer invoiceIdentifier)
void	setItemOutstandingInvoiceAmount(org.kuali.rice.core.api.util.type.KualiDecimal itemOutstandingInvoiceAmount)
void	setItemOutstandingInvoiceQuantity(org.kuali.rice.core.api.util.type.KualiDecimal itemOutstandingInvoiceQuantity)
void	setOriginalAmountfromPO(BigDecimal purchaseOrderItemUnitPrice)
void	setPoItem(PurchaseOrderItem poItem)
void	setPoLineNumber(Integer poLineNumber)
void	setPoOutstandingAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount) Deprecated.
void	setPoOutstandingQuantity(org.kuali.rice.core.api.util.type.KualiDecimal qty) Deprecated.
void	setPostingYear(Integer postingYear)
void	setPurchaseOrderDocument(PurchaseOrderDocument purchaseOrderDocument)
void	setPurchaseOrderIdentifier(Integer purchaseOrderIdentifier)
void	setPurchaseOrderItemUnitPrice(BigDecimal purchaseOrderItemUnitPrice)
void	setReceivingDocumentRequiredIndicator(boolean receivingDocumentRequiredIndicator) Sets the receivingDocumentRequiredIndicator attribute value.
void	setRecurringPaymentType(RecurringPaymentType recurringPaymentType)
void	setRecurringPaymentTypeCode(String recurringPaymentTypeCode)
void	setReopenPurchaseOrderIndicator(boolean reopenPurchaseOrderIndicator)

Methods inherited from class org.kuali.ole.module.purap.businessobject.AccountsPayableItemBase

getCapitalAssetTransactionType, getCapitalAssetTransactionTypeCode, getExtendedPrice, getSummaryItem, isConsideredEntered, isConsideredEnteredWithoutZero, isConsideredEnteredWithZero, isEligibleDisplay, isNonZeroAmount, setCapitalAssetTransactionTypeCode, setExtendedPrice, setItemDescription

Methods inherited from class org.kuali.ole.module.purap.businessobject.PurApItemBase

buildListOfDeletionAwareLists, calculateExtendedPrice, fixAccountReferences, getBaselineSourceAccountingLine, getBaselineSourceAccountingLines, getExternalOrganizationB2bProductReferenceNumber, getExternalOrganizationB2bProductTypeName, getItemAssignedToTradeInIndicator, getItemAuxiliaryPartIdentifier, getItemCatalogNumber, getItemDescription, getItemIdentifier, getItemIdentifierString, getItemLineNumber, getItemQuantity, getItemSalesTaxAmount, getItemTaxAmount, getItemType, getItemTypeCode, getItemUnitOfMeasureCode, getItemUnitPrice, getNewSourceLine, getPurapDocument, getPurapDocumentIdentifier, getSourceAccountingLine, getSourceAccountingLines, getTotalAmount, getTotalRemitAmount, getUseTaxItems, isAccountListEmpty, refreshNonUpdateableReferences, resetAccount, setBaselineSourceAccountingLines, setExternalOrganizationB2bProductReferenceNumber, setExternalOrganizationB2bProductTypeName, setItemAssignedToTradeInIndicator, setItemAuxiliaryPartIdentifier, setItemCatalogNumber, setItemIdentifier, setItemLineNumber, setItemQuantity, setItemSalesTaxAmount, setItemTaxAmount, setItemType, setItemTypeCode, setItemUnitOfMeasureCode, setItemUnitPrice, setNewSourceLine, setPurapDocument, setPurapDocumentIdentifier, setSourceAccountingLines, setTotalAmount, setUseTaxItems, toString, toStringMapper_RICE20_REFACTORME

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

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

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.businessobject.PurApItem

calculateExtendedPrice, fixAccountReferences, getBaselineSourceAccountingLines, getExternalOrganizationB2bProductReferenceNumber, getExternalOrganizationB2bProductTypeName, getItemAssignedToTradeInIndicator, getItemAuxiliaryPartIdentifier, getItemCatalogNumber, getItemDescription, getItemIdentifier, getItemIdentifierString, getItemLineNumber, getItemQuantity, getItemTaxAmount, getItemType, getItemTypeCode, getItemUnitOfMeasureCode, getItemUnitPrice, getNewSourceLine, getPurapDocument, getPurapDocumentIdentifier, getSourceAccountingLines, getTotalAmount, getTotalRemitAmount, getUseTaxItems, resetAccount, setExternalOrganizationB2bProductReferenceNumber, setExternalOrganizationB2bProductTypeName, setItemAssignedToTradeInIndicator, setItemAuxiliaryPartIdentifier, setItemCatalogNumber, setItemIdentifier, setItemLineNumber, setItemQuantity, setItemTaxAmount, setItemType, setItemTypeCode, setItemUnitOfMeasureCode, setItemUnitPrice, setNewSourceLine, setPurapDocument, setPurapDocumentIdentifier, setSourceAccountingLines, setTotalAmount, setUseTaxItems

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.apache.ojb.broker.PersistenceBrokerAware

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

Field Detail

accountsPayablePurchasingDocumentLinkIdentifier

protected Integer accountsPayablePurchasingDocumentLinkIdentifier

poLineNumber

protected Integer poLineNumber

closePurchaseOrderIndicator

protected boolean closePurchaseOrderIndicator

reopenPurchaseOrderIndicator

protected boolean reopenPurchaseOrderIndicator

postingYear

protected Integer postingYear

recurringPaymentTypeCode

protected String recurringPaymentTypeCode

recurringPaymentType

protected RecurringPaymentType recurringPaymentType

receivingDocumentRequiredIndicator

protected boolean receivingDocumentRequiredIndicator

purchaseOrderDocument

protected PurchaseOrderDocument purchaseOrderDocument

Constructor Detail

InvoiceItem

public InvoiceItem()

Default constructor.

InvoiceItem

public InvoiceItem(PurchaseOrderItem poi,
           InvoiceDocument inv)

inv item constructor - Delegate

Parameters:

poi - - purchase order item

inv - - payment request document

InvoiceItem

public InvoiceItem(PurchaseOrderItem poi,
           InvoiceDocument inv,
           HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)

Constructs a new payment request item, but also merges expired accounts.

Parameters:

poi - - purchase order item

inv - - payment request document

expiredOrClosedAccountList - - list of expired or closed accounts to merge

Method Detail

getPurchaseOrderItem

public PurchaseOrderItem getPurchaseOrderItem()

Retrieves a purchase order item by inspecting the item type to see if its above the line or below the line and returns the appropriate type.

Returns:

- purchase order item

getPoOutstandingAmount

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

getPoOriginalAmount

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

setPoOutstandingAmount

@Deprecated
public void setPoOutstandingAmount(org.kuali.rice.core.api.util.type.KualiDecimal amount)

Deprecated.

Exists due to a setter requirement by the htmlControlAttribute

Parameters:

amount - - po outstanding amount

getPoOutstandingQuantity

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

setPoOutstandingQuantity

@Deprecated
public void setPoOutstandingQuantity(org.kuali.rice.core.api.util.type.KualiDecimal qty)

Deprecated.

Exists due to a setter requirement by the htmlControlAttribute

Parameters:

qty - - po outstanding quantity

getPurchaseOrderItemUnitPrice

public BigDecimal getPurchaseOrderItemUnitPrice()

getAccountsPayablePurchasingDocumentLinkIdentifier

public Integer getAccountsPayablePurchasingDocumentLinkIdentifier()

setAccountsPayablePurchasingDocumentLinkIdentifier

public void setAccountsPayablePurchasingDocumentLinkIdentifier(Integer accountsPayablePurchasingDocumentLinkIdentifier)

getPoLineNumber

public Integer getPoLineNumber()

setPoLineNumber

public void setPoLineNumber(Integer poLineNumber)

getPurchaseOrderIdentifier

public Integer getPurchaseOrderIdentifier()

setPurchaseOrderIdentifier

public void setPurchaseOrderIdentifier(Integer purchaseOrderIdentifier)

getInvoiceIdentifier

public Integer getInvoiceIdentifier()

setInvoiceIdentifier

public void setInvoiceIdentifier(Integer invoiceIdentifier)

getOriginalAmountfromPO

public BigDecimal getOriginalAmountfromPO()

setOriginalAmountfromPO

public void setOriginalAmountfromPO(BigDecimal purchaseOrderItemUnitPrice)

getPostingYear

public Integer getPostingYear()

setPostingYear

public void setPostingYear(Integer postingYear)

See Also:

LedgerPostingDocument.setPostingYear(Integer)

setPurchaseOrderItemUnitPrice

public void setPurchaseOrderItemUnitPrice(BigDecimal purchaseOrderItemUnitPrice)

getItemOutstandingInvoiceAmount

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

setItemOutstandingInvoiceAmount

public void setItemOutstandingInvoiceAmount(org.kuali.rice.core.api.util.type.KualiDecimal itemOutstandingInvoiceAmount)

getItemOutstandingInvoiceQuantity

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

setItemOutstandingInvoiceQuantity

public void setItemOutstandingInvoiceQuantity(org.kuali.rice.core.api.util.type.KualiDecimal itemOutstandingInvoiceQuantity)

getInvoice

public InvoiceDocument getInvoice()

setInvoice

public void setInvoice(InvoiceDocument invoice)

isClosePurchaseOrderIndicator

public boolean isClosePurchaseOrderIndicator()

setClosePurchaseOrderIndicator

public void setClosePurchaseOrderIndicator(boolean closePurchaseOrderIndicator)

isReopenPurchaseOrderIndicator

public boolean isReopenPurchaseOrderIndicator()

setReopenPurchaseOrderIndicator

public void setReopenPurchaseOrderIndicator(boolean reopenPurchaseOrderIndicator)

getRecurringPaymentTypeCode

public String getRecurringPaymentTypeCode()

setRecurringPaymentTypeCode

public void setRecurringPaymentTypeCode(String recurringPaymentTypeCode)

getRecurringPaymentType

public RecurringPaymentType getRecurringPaymentType()

setRecurringPaymentType

public void setRecurringPaymentType(RecurringPaymentType recurringPaymentType)

generateAccountListFromPoItemAccounts

public void generateAccountListFromPoItemAccounts(List<PurApAccountingLine> accounts)

getAccountingLineClass

public Class getAccountingLineClass()

Specified by:

getAccountingLineClass in interface PurApItem

Specified by:

getAccountingLineClass in class PurApItemBase

See Also:

PurApItem.getAccountingLineClass()

isDisplayOnPreq

public boolean isDisplayOnPreq()

resetAccount

public void resetAccount()

sets account line percentage to zero.

Specified by:

resetAccount in interface PurApItem

Overrides:

resetAccount in class PurApItemBase

See Also:

PurApItem.resetAccount()

addToUnitPrice

public void addToUnitPrice(BigDecimal addThisValue)

Added for electronic invoice

addToExtendedPrice

public void addToExtendedPrice(org.kuali.rice.core.api.util.type.KualiDecimal addThisValue)

getUseTaxClass

public Class getUseTaxClass()

Specified by:

getUseTaxClass in interface PurApItem

Specified by:

getUseTaxClass in class PurApItemBase

isReceivingDocumentRequiredIndicator

public boolean isReceivingDocumentRequiredIndicator()

Gets the receivingDocumentRequiredIndicator attribute.

Returns:

Returns the receivingDocumentRequiredIndicator.

setReceivingDocumentRequiredIndicator

public void setReceivingDocumentRequiredIndicator(boolean receivingDocumentRequiredIndicator)

Sets the receivingDocumentRequiredIndicator attribute value.

Parameters:

receivingDocumentRequiredIndicator - The receivingDocumentRequiredIndicator to set.

isEnableReceivingDocumentRequiredIndicator

public boolean isEnableReceivingDocumentRequiredIndicator()

Decides whether receivingDocumentRequiredIndicator functionality shall be enabled according to the controlling parameter.

getPurchaseOrderDocument

public PurchaseOrderDocument getPurchaseOrderDocument()

See Also:

AccountsPayableDocument.getPurchaseOrderDocument()

setPurchaseOrderDocument

public void setPurchaseOrderDocument(PurchaseOrderDocument purchaseOrderDocument)

See Also:

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

getPoItem

public PurchaseOrderItem getPoItem()

setPoItem

public void setPoItem(PurchaseOrderItem poItem)