org.kuali.kfs.module.ar.businessobject
Class CustomerCreditMemoDetail

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.kfs.module.ar.businessobject.CustomerCreditMemoDetail

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, AppliedPayment, GeneralLedgerPendingEntrySourceDetail, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject

Direct Known Subclasses:

ReceivableCustomerCreditMemoDetail, SalesTaxCustomerCreditMemoDetail

public class CustomerCreditMemoDetail
extends org.kuali.rice.kns.bo.PersistableBusinessObjectBase
implements GeneralLedgerPendingEntrySourceDetail, AppliedPayment

Author:

Kuali Nervous System Team (kualidev@oncourse.iu.edu)

See Also:

Serialized Form

Field Summary

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

extension, versionNumber

Constructor Summary

CustomerCreditMemoDetail()
Default constructor.

Method Summary

Account	getAccount()
String	getAccountNumber()
ObjectCode	getAccountsReceivableObject()
String	getAccountsReceivableObjectCode()
org.kuali.rice.kns.util.KualiDecimal	getAmount()
String	getBalanceTypeCode()
String	getChartOfAccountsCode()
BigDecimal	getCreditMemoItemQuantity() Gets the creditMemoItemQuantity attribute.
org.kuali.rice.kns.util.KualiDecimal	getCreditMemoItemTaxAmount() Gets the creditMemoItemTaxAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getCreditMemoItemTotalAmount() Gets the creditMemoItemTotalAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getCreditMemoLineTotalAmount() Gets the creditMemoLineTotalAmount attribute.
CustomerInvoiceDetail	getCustomerInvoiceDetail()
String	getDocumentNumber() Gets the documentNumber attribute.
org.kuali.rice.kns.util.KualiDecimal	getDuplicateCreditMemoItemTotalAmount() Gets the duplicateCreditMemoItemTotalAmount attribute.
String	getFinancialDocumentLineDescription()
String	getFinancialDocumentReferenceInvoiceNumber() Gets the financialDocumentReferenceInvoiceNumber attribute.
String	getFinancialObjectCode()
String	getFinancialSubObjectCode()
Integer	getInvoiceItemNumber() This method returns the invoice detail item number that the amount is being applied to
org.kuali.rice.kns.util.KualiDecimal	getInvoiceLineTotalAmount() Gets the invoiceLineTotalAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getInvoiceOpenItemAmount() Gets the invoiceOpenItemAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getInvoiceOpenItemQuantity() Gets the invoiceOpenItemQuantity attribute.
String	getInvoiceReferenceNumber() This method returns the invoice reference number
ObjectCode	getObjectCode()
String	getOrganizationReferenceId()
Integer	getPostingYear()
String	getProjectCode()
Integer	getReferenceInvoiceItemNumber() Gets the referenceInvoiceItemNumber attribute.
String	getReferenceNumber()
String	getReferenceOriginCode()
String	getReferenceTypeCode()
String	getSubAccountNumber()
boolean	isInvoiceOpenItemQuantityZero()
void	recalculateBasedOnEnteredItemAmount(CustomerCreditMemoDocument customerCreditMemoDocument)
void	recalculateBasedOnEnteredItemQty(CustomerCreditMemoDocument customerCreditMemoDocument)
void	setCreditMemoItemQuantity(BigDecimal creditMemoItemQuantity) Sets the creditMemoItemQuantity attribute.
void	setCreditMemoItemTaxAmount(org.kuali.rice.kns.util.KualiDecimal creditMemoItemTaxAmount) Sets the creditMemoItemTaxAmount attribute.
void	setCreditMemoItemTotalAmount(org.kuali.rice.kns.util.KualiDecimal creditMemoItemTotalAmount) Sets the creditMemoItemTotalAmount attribute.
void	setCreditMemoLineTotalAmount(org.kuali.rice.kns.util.KualiDecimal creditMemoLineTotalAmount) Sets the creditMemoLineTotalAmount attribute value.
void	setCustomerInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail) Sets the customerInvoiceDetail attribute value.
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute.
void	setDuplicateCreditMemoItemTotalAmount(org.kuali.rice.kns.util.KualiDecimal duplicateCreditMemoItemTotalAmount) Sets the duplicateCreditMemoItemTotalAmount attribute value.
void	setFinancialDocumentReferenceInvoiceNumber(String financialDocumentReferenceInvoiceNumber) Sets the financialDocumentReferenceInvoiceNumber attribute value.
void	setInvoiceLineTotalAmount(org.kuali.rice.kns.util.KualiDecimal invoiceLineTotalAmount)
void	setInvoiceLineTotalAmount(org.kuali.rice.kns.util.KualiDecimal tax, org.kuali.rice.kns.util.KualiDecimal invItemAmount) Sets the invoiceLineTotalAmount attribute value.
void	setInvoiceOpenItemAmount(org.kuali.rice.kns.util.KualiDecimal invoiceOpenItemAmount) Sets the invoiceOpenItemAmount attribute value.
void	setInvoiceOpenItemQuantity(org.kuali.rice.kns.util.KualiDecimal invoiceOpenItemQuantity) Sets the invoiceOpenItemQuantity attribute value.
void	setInvoiceOpenItemQuantityZero(boolean invoiceOpenItemQuantityZero)
void	setReferenceInvoiceItemNumber(Integer referenceInvoiceItemNumber) Sets the referenceInvoiceItemNumber attribute.
protected LinkedHashMap	toStringMapper()

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

addNote, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

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

prepareForWorkflow, toString, toStringBuilder

Methods inherited from class java.lang.Object

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

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.kuali.rice.kns.bo.BusinessObject

prepareForWorkflow, refresh

Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware

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

Constructor Detail

CustomerCreditMemoDetail

public CustomerCreditMemoDetail()

Default constructor.

Method Detail

getDocumentNumber

public String getDocumentNumber()

Gets the documentNumber attribute.

Specified by:

getDocumentNumber in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the documentNumber

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Sets the documentNumber attribute.

Parameters:

documentNumber - The documentNumber to set.

getReferenceInvoiceItemNumber

public Integer getReferenceInvoiceItemNumber()

Gets the referenceInvoiceItemNumber attribute.

Returns:

Returns the referenceInvoiceItemNumber

setReferenceInvoiceItemNumber

public void setReferenceInvoiceItemNumber(Integer referenceInvoiceItemNumber)

Sets the referenceInvoiceItemNumber attribute.

Parameters:

referenceInvoiceItemNumber - The referenceInvoiceItemNumber to set.

getCreditMemoItemQuantity

public BigDecimal getCreditMemoItemQuantity()

Gets the creditMemoItemQuantity attribute.

Returns:

Returns the creditMemoItemQuantity

setCreditMemoItemQuantity

public void setCreditMemoItemQuantity(BigDecimal creditMemoItemQuantity)

Sets the creditMemoItemQuantity attribute.

Parameters:

creditMemoItemQuantity - The creditMemoItemQuantity to set.

getCreditMemoItemTaxAmount

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

Gets the creditMemoItemTaxAmount attribute.

Returns:

Returns the creditMemoItemTaxAmount

setCreditMemoItemTaxAmount

public void setCreditMemoItemTaxAmount(org.kuali.rice.kns.util.KualiDecimal creditMemoItemTaxAmount)

Sets the creditMemoItemTaxAmount attribute.

Parameters:

creditMemoItemTaxAmount - The creditMemoItemTaxAmount to set.

getCreditMemoItemTotalAmount

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

Gets the creditMemoItemTotalAmount attribute.

Returns:

Returns the creditMemoItemTotalAmount

setCreditMemoItemTotalAmount

public void setCreditMemoItemTotalAmount(org.kuali.rice.kns.util.KualiDecimal creditMemoItemTotalAmount)

Sets the creditMemoItemTotalAmount attribute.

Parameters:

creditMemoItemTotalAmount - The creditMemoItemTotalAmount to set.

getInvoiceOpenItemAmount

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

Gets the invoiceOpenItemAmount attribute.

Returns:

Returns the invoiceOpenItemAmount.

setInvoiceOpenItemAmount

public void setInvoiceOpenItemAmount(org.kuali.rice.kns.util.KualiDecimal invoiceOpenItemAmount)

Sets the invoiceOpenItemAmount attribute value.

Parameters:

invoiceOpenItemAmount - The invoiceOpenItemAmount to set.

getInvoiceLineTotalAmount

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

Gets the invoiceLineTotalAmount attribute.

Returns:

Returns the invoiceLineTotalAmount.

setInvoiceLineTotalAmount

public void setInvoiceLineTotalAmount(org.kuali.rice.kns.util.KualiDecimal tax,
                                      org.kuali.rice.kns.util.KualiDecimal invItemAmount)

Sets the invoiceLineTotalAmount attribute value.

Parameters:

invoiceLineTotalAmount - The invoiceLineTotalAmount to set.

getCreditMemoLineTotalAmount

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

Gets the creditMemoLineTotalAmount attribute.

Returns:

Returns the creditMemoLineTotalAmount.

setCreditMemoLineTotalAmount

public void setCreditMemoLineTotalAmount(org.kuali.rice.kns.util.KualiDecimal creditMemoLineTotalAmount)

Sets the creditMemoLineTotalAmount attribute value.

Parameters:

creditMemoLineTotalAmount - The creditMemoLineTotalAmount to set.

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

toStringMapper in class org.kuali.rice.kns.bo.BusinessObjectBase

See Also:

BusinessObjectBase.toStringMapper()

setInvoiceLineTotalAmount

public void setInvoiceLineTotalAmount(org.kuali.rice.kns.util.KualiDecimal invoiceLineTotalAmount)

recalculateBasedOnEnteredItemQty

public void recalculateBasedOnEnteredItemQty(CustomerCreditMemoDocument customerCreditMemoDocument)

recalculateBasedOnEnteredItemAmount

public void recalculateBasedOnEnteredItemAmount(CustomerCreditMemoDocument customerCreditMemoDocument)

getDuplicateCreditMemoItemTotalAmount

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

Gets the duplicateCreditMemoItemTotalAmount attribute.

Returns:

Returns the duplicateCreditMemoItemTotalAmount.

setDuplicateCreditMemoItemTotalAmount

public void setDuplicateCreditMemoItemTotalAmount(org.kuali.rice.kns.util.KualiDecimal duplicateCreditMemoItemTotalAmount)

Sets the duplicateCreditMemoItemTotalAmount attribute value.

Parameters:

duplicateCreditMemoItemTotalAmount - The duplicateCreditMemoItemTotalAmount to set.

getInvoiceOpenItemQuantity

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

Gets the invoiceOpenItemQuantity attribute.

Returns:

Returns the invoiceOpenItemQuantity.

setInvoiceOpenItemQuantity

public void setInvoiceOpenItemQuantity(org.kuali.rice.kns.util.KualiDecimal invoiceOpenItemQuantity)

Sets the invoiceOpenItemQuantity attribute value.

Parameters:

invoiceOpenItemQuantity - The invoiceOpenItemQuantity to set.

getChartOfAccountsCode

public String getChartOfAccountsCode()

Specified by:

getChartOfAccountsCode in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the chartOfAccountsCode.

getAccountNumber

public String getAccountNumber()

Specified by:

getAccountNumber in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the accountNumber.

getAccount

public Account getAccount()

Specified by:

getAccount in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the account.

getFinancialObjectCode

public String getFinancialObjectCode()

Specified by:

getFinancialObjectCode in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the financialObjectCode.

getObjectCode

public ObjectCode getObjectCode()

Specified by:

getObjectCode in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the objectCode.

getOrganizationReferenceId

public String getOrganizationReferenceId()

Specified by:

getOrganizationReferenceId in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the organizationReferenceId.

getProjectCode

public String getProjectCode()

Specified by:

getProjectCode in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the projectCode.

getReferenceNumber

public String getReferenceNumber()

Specified by:

getReferenceNumber in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the referenceNumber.

getReferenceTypeCode

public String getReferenceTypeCode()

Specified by:

getReferenceTypeCode in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the referenceTypeCode.

getReferenceOriginCode

public String getReferenceOriginCode()

Specified by:

getReferenceOriginCode in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the referenceOriginCode.

getSubAccountNumber

public String getSubAccountNumber()

Specified by:

getSubAccountNumber in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the subAccountNumber.

getFinancialSubObjectCode

public String getFinancialSubObjectCode()

Specified by:

getFinancialSubObjectCode in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the financialSubObjectCode.

getFinancialDocumentLineDescription

public String getFinancialDocumentLineDescription()

Specified by:

getFinancialDocumentLineDescription in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the financialDocumentLineDescription.

getAmount

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

Specified by:

getAmount in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the amount.

getPostingYear

public Integer getPostingYear()

Specified by:

getPostingYear in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the postingYear.

getBalanceTypeCode

public String getBalanceTypeCode()

Specified by:

getBalanceTypeCode in interface GeneralLedgerPendingEntrySourceDetail

Returns:

Returns the balanceTypeCode.

getAccountsReceivableObject

public ObjectCode getAccountsReceivableObject()

getAccountsReceivableObjectCode

public String getAccountsReceivableObjectCode()

getCustomerInvoiceDetail

public CustomerInvoiceDetail getCustomerInvoiceDetail()

setCustomerInvoiceDetail

public void setCustomerInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail)

Sets the customerInvoiceDetail attribute value.

Parameters:

customerInvoiceDetail - The customerInvoiceDetail to set.

getFinancialDocumentReferenceInvoiceNumber

public String getFinancialDocumentReferenceInvoiceNumber()

Gets the financialDocumentReferenceInvoiceNumber attribute.

Returns:

Returns the financialDocumentReferenceInvoiceNumber.

setFinancialDocumentReferenceInvoiceNumber

public void setFinancialDocumentReferenceInvoiceNumber(String financialDocumentReferenceInvoiceNumber)

Sets the financialDocumentReferenceInvoiceNumber attribute value.

Parameters:

financialDocumentReferenceInvoiceNumber - The financialDocumentReferenceInvoiceNumber to set.

getInvoiceItemNumber

public Integer getInvoiceItemNumber()

Description copied from interface: AppliedPayment

This method returns the invoice detail item number that the amount is being applied to

Specified by:

getInvoiceItemNumber in interface AppliedPayment

Returns:

getInvoiceReferenceNumber

public String getInvoiceReferenceNumber()

Description copied from interface: AppliedPayment

This method returns the invoice reference number

Specified by:

getInvoiceReferenceNumber in interface AppliedPayment

Returns:

isInvoiceOpenItemQuantityZero

public boolean isInvoiceOpenItemQuantityZero()

setInvoiceOpenItemQuantityZero

public void setInvoiceOpenItemQuantityZero(boolean invoiceOpenItemQuantityZero)