org.kuali.kfs.module.purap.businessobject
Class PaymentRequestItem

java.lang.Object
  extended by org.kuali.rice.kns.bo.BusinessObjectBase
      extended by org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          extended by org.kuali.kfs.module.purap.businessobject.PurApItemBase
              extended by org.kuali.kfs.module.purap.businessobject.AccountsPayableItemBase
                  extended by org.kuali.kfs.module.purap.businessobject.PaymentRequestItem
All Implemented Interfaces:
Serializable, org.apache.ojb.broker.PersistenceBrokerAware, ExternalPurApItem, AccountsPayableItem, PurapEnterableItem, PurApItem, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.ExternalizableBusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject

public class PaymentRequestItem
extends AccountsPayableItemBase

Payment Request Item Business Object.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase
extension, versionNumber
 
Constructor Summary
PaymentRequestItem()
          Default constructor.
PaymentRequestItem(PurchaseOrderItem poi, PaymentRequestDocument preq)
          preq item constructor - Delegate
PaymentRequestItem(PurchaseOrderItem poi, PaymentRequestDocument preq, HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)
          Constructs a new payment request item, but also merges expired accounts.
 
Method Summary
 void addToExtendedPrice(org.kuali.rice.kns.util.KualiDecimal addThisValue)
           
 void addToUnitPrice(BigDecimal addThisValue)
          Added for electronic invoice
 void generateAccountListFromPoItemAccounts(List<PurApAccountingLine> accounts)
           
 Class getAccountingLineClass()
           
 org.kuali.rice.kns.util.KualiDecimal getItemOutstandingInvoiceAmount()
           
 org.kuali.rice.kns.util.KualiDecimal getItemOutstandingInvoiceQuantity()
           
 BigDecimal getOriginalAmountfromPO()
           
 PaymentRequestDocument getPaymentRequest()
           
 org.kuali.rice.kns.util.KualiDecimal getPoOriginalAmount()
           
 org.kuali.rice.kns.util.KualiDecimal getPoOutstandingAmount()
           
 org.kuali.rice.kns.util.KualiDecimal getPoOutstandingQuantity()
           
 PurchaseOrderItem getPurchaseOrderItem()
          Retreives 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()
           
 Class getUseTaxClass()
           
 boolean isDisplayOnPreq()
           
 void resetAccount()
          sets account line percentage to zero.
 void setItemOutstandingInvoiceAmount(org.kuali.rice.kns.util.KualiDecimal itemOutstandingInvoiceAmount)
           
 void setItemOutstandingInvoiceQuantity(org.kuali.rice.kns.util.KualiDecimal itemOutstandingInvoiceQuantity)
           
 void setOriginalAmountfromPO(BigDecimal purchaseOrderItemUnitPrice)
           
 void setPaymentRequest(PaymentRequestDocument paymentRequest)
           
 void setPoOutstandingAmount(org.kuali.rice.kns.util.KualiDecimal amount)
          Deprecated.  
 void setPoOutstandingQuantity(org.kuali.rice.kns.util.KualiDecimal qty)
          Deprecated.  
 void setPurchaseOrderItemUnitPrice(BigDecimal purchaseOrderItemUnitPrice)
           
 
Methods inherited from class org.kuali.kfs.module.purap.businessobject.AccountsPayableItemBase
getCapitalAssetTransactionType, getCapitalAssetTransactionTypeCode, getExtendedPrice, getSummaryItem, isConsideredEntered, isConsideredEnteredWithoutZero, isConsideredEnteredWithZero, isEligibleDisplay, isNonZeroAmount, setCapitalAssetTransactionTypeCode, setExtendedPrice, setItemDescription
 
Methods inherited from class org.kuali.kfs.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, setBaselineSourceAccountingLines, setExternalOrganizationB2bProductReferenceNumber, setExternalOrganizationB2bProductTypeName, setItemAssignedToTradeInIndicator, setItemAuxiliaryPartIdentifier, setItemCatalogNumber, setItemIdentifier, setItemLineNumber, setItemQuantity, setItemSalesTaxAmount, setItemTaxAmount, setItemType, setItemTypeCode, setItemUnitOfMeasureCode, setItemUnitPrice, setNewSourceLine, setPurapDocument, setPurapDocumentIdentifier, setSourceAccountingLines, setTotalAmount, setUseTaxItems, toString, toStringMapper
 
Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase
addNote, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refresh, refreshReferenceObject, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes
 
Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase
prepareForWorkflow, toStringBuilder
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.kuali.kfs.module.purap.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, 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.kns.bo.PersistableBusinessObject
addNote, buildListOfDeletionAwareLists, deleteNote, getBoNote, getBoNotes, getExtension, getObjectId, getVersionNumber, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber
 
Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware
afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate
 
Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject
prepareForWorkflow, refresh
 

Constructor Detail

PaymentRequestItem

public PaymentRequestItem()
Default constructor.


PaymentRequestItem

public PaymentRequestItem(PurchaseOrderItem poi,
                          PaymentRequestDocument preq)
preq item constructor - Delegate

Parameters:
poi - - purchase order item
preq - - payment request document

PaymentRequestItem

public PaymentRequestItem(PurchaseOrderItem poi,
                          PaymentRequestDocument preq,
                          HashMap<String,ExpiredOrClosedAccountEntry> expiredOrClosedAccountList)
Constructs a new payment request item, but also merges expired accounts.

Parameters:
poi - - purchase order item
preq - - payment request document
expiredOrClosedAccountList - - list of expired or closed accounts to merge
Method Detail

getPurchaseOrderItem

public PurchaseOrderItem getPurchaseOrderItem()
Retreives 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.kns.util.KualiDecimal getPoOutstandingAmount()

getPoOriginalAmount

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

setPoOutstandingAmount

public void setPoOutstandingAmount(org.kuali.rice.kns.util.KualiDecimal amount)
Deprecated. 

Exists due to a setter requirement by the htmlControlAttribute

Parameters:
amount - - po outstanding amount

getPoOutstandingQuantity

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

setPoOutstandingQuantity

public void setPoOutstandingQuantity(org.kuali.rice.kns.util.KualiDecimal qty)
Deprecated. 

Exists due to a setter requirement by the htmlControlAttribute

Parameters:
amount - - po outstanding quantity

getPurchaseOrderItemUnitPrice

public BigDecimal getPurchaseOrderItemUnitPrice()

getOriginalAmountfromPO

public BigDecimal getOriginalAmountfromPO()

setOriginalAmountfromPO

public void setOriginalAmountfromPO(BigDecimal purchaseOrderItemUnitPrice)

setPurchaseOrderItemUnitPrice

public void setPurchaseOrderItemUnitPrice(BigDecimal purchaseOrderItemUnitPrice)

getItemOutstandingInvoiceAmount

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

setItemOutstandingInvoiceAmount

public void setItemOutstandingInvoiceAmount(org.kuali.rice.kns.util.KualiDecimal itemOutstandingInvoiceAmount)

getItemOutstandingInvoiceQuantity

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

setItemOutstandingInvoiceQuantity

public void setItemOutstandingInvoiceQuantity(org.kuali.rice.kns.util.KualiDecimal itemOutstandingInvoiceQuantity)

getPaymentRequest

public PaymentRequestDocument getPaymentRequest()

setPaymentRequest

public void setPaymentRequest(PaymentRequestDocument paymentRequest)

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.kns.util.KualiDecimal addThisValue)

getUseTaxClass

public Class getUseTaxClass()
Specified by:
getUseTaxClass in interface PurApItem
Specified by:
getUseTaxClass in class PurApItemBase


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.