org.kuali.kfs.pdp.businessobject
Class PaymentDetail

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.kfs.sys.businessobject.TimestampedBusinessObjectBase
              org.kuali.kfs.pdp.businessobject.PaymentDetail

All Implemented Interfaces:

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

Direct Known Subclasses:

BankChangeHistory, PurchasingPaymentDetail

public class PaymentDetail
extends TimestampedBusinessObjectBase

See Also:

Serialized Form

Field Summary

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

extension, versionNumber

Constructor Summary

PaymentDetail()

Method Summary

void	addAccountDetail(PaymentAccountDetail pad)
void	addNote(PaymentNoteText pnt)
void	addPaymentText(String paymentText) Constructs a new PaymentNoteText for the given payment text and adds to the detail List
void	deleteAccountDetail(PaymentAccountDetail pad)
void	deleteNote(PaymentNoteText pnt)
List<PaymentAccountDetail>	getAccountDetail()
org.kuali.rice.kns.util.KualiDecimal	getAccountTotal()
org.kuali.rice.kns.util.KualiDecimal	getCalculatedPaymentAmount()
String	getCustPaymentDocNbr()
String	getFinancialDocumentTypeCode()
String	getFinancialSystemOriginCode() Gets the financialSystemOriginCode attribute.
org.kuali.rice.kns.util.KualiInteger	getId()
Date	getInvoiceDate()
String	getInvoiceNbr()
org.kuali.rice.kns.util.KualiDecimal	getInvTotDiscountAmount()
org.kuali.rice.kns.util.KualiDecimal	getInvTotOtherCreditAmount()
org.kuali.rice.kns.util.KualiDecimal	getInvTotOtherDebitAmount()
org.kuali.rice.kns.util.KualiDecimal	getInvTotShipAmount()
int	getNbrOfPaymentsInDisbursement() This method returns the number of payments in the disbursement associated with this payment detail.
int	getNbrOfPaymentsInPaymentGroup() This method returns the number of payments in the payment group associated with this payment detail.
org.kuali.rice.kns.util.KualiDecimal	getNetPaymentAmount()
List<PaymentNoteText>	getNotes()
String	getNotesText() This method returns a String representation of the payment detail notes
String	getOrganizationDocNbr()
org.kuali.rice.kns.util.KualiDecimal	getOrigInvoiceAmount()
PaymentGroup	getPaymentGroup()
org.kuali.rice.kns.util.KualiInteger	getPaymentGroupId() Gets the paymentGroupId attribute.
Boolean	getPrimaryCancelledPayment()
String	getPurchaseOrderNbr()
String	getRequisitionNbr()
boolean	isDetailAmountProvided()
boolean	isDisbursementActionAllowed() Determines if the disbursement date is past the number of days old (configured in system parameter) in which actions can take place
void	setAccountDetail(List<PaymentAccountDetail> ad)
void	setCustPaymentDocNbr(String string)
void	setFinancialDocumentTypeCode(String financialDocumentTypeCode)
void	setFinancialSystemOriginCode(String financialSystemOriginCode) Sets the financialSystemOriginCode attribute value.
void	setId(org.kuali.rice.kns.util.KualiInteger integer)
void	setInvoiceDate(Date invoiceDate)
void	setInvoiceDate(String invoiceDate) Takes a String and attempt to format as Timestamp
void	setInvoiceNbr(String string)
void	setInvTotDiscountAmount(org.kuali.rice.kns.util.KualiDecimal decimal)
void	setInvTotDiscountAmount(String decimal)
void	setInvTotOtherCreditAmount(org.kuali.rice.kns.util.KualiDecimal decimal)
void	setInvTotOtherCreditAmount(String decimal)
void	setInvTotOtherDebitAmount(org.kuali.rice.kns.util.KualiDecimal decimal)
void	setInvTotOtherDebitAmount(String decimal)
void	setInvTotShipAmount(org.kuali.rice.kns.util.KualiDecimal decimal)
void	setInvTotShipAmount(String decimal)
void	setNetPaymentAmount(org.kuali.rice.kns.util.KualiDecimal decimal)
void	setNetPaymentAmount(String decimal)
void	setNotes(List<PaymentNoteText> n)
void	setOrganizationDocNbr(String string)
void	setOrigInvoiceAmount(org.kuali.rice.kns.util.KualiDecimal decimal)
void	setOrigInvoiceAmount(String decimal)
void	setPaymentGroup(PaymentGroup paymentGroup)
void	setPaymentGroupId(org.kuali.rice.kns.util.KualiInteger paymentGroupId) Sets the paymentGroupId attribute value.
void	setPrimaryCancelledPayment(Boolean primaryCancelledPayment)
void	setPurchaseOrderNbr(String string)
void	setRequisitionNbr(String string)
protected LinkedHashMap	toStringMapper()

Methods inherited from class org.kuali.kfs.sys.businessobject.TimestampedBusinessObjectBase

beforeInsert, beforeUpdate, getLastUpdate, getLastUpdateUser, getLastUpdateUserId, setLastUpdate, setLastUpdateUserId

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

addNote, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, 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.BusinessObject

prepareForWorkflow

Constructor Detail

PaymentDetail

public PaymentDetail()

Method Detail

isDetailAmountProvided

public boolean isDetailAmountProvided()

getCalculatedPaymentAmount

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

isDisbursementActionAllowed

public boolean isDisbursementActionAllowed()

Determines if the disbursement date is past the number of days old (configured in system parameter) in which actions can take place

Returns:

true if actions are allowed on disbursement, false otherwise

getAccountTotal

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

Returns:

total of all account detail amounts

getInvoiceDate

public Date getInvoiceDate()

setInvoiceDate

public void setInvoiceDate(Date invoiceDate)

setInvoiceDate

public void setInvoiceDate(String invoiceDate)
                    throws ParseException

Takes a String and attempt to format as Timestamp

Parameters:

invoiceDate - Timestamp as string

Throws:

ParseException

getAccountDetail

public List<PaymentAccountDetail> getAccountDetail()

setAccountDetail

public void setAccountDetail(List<PaymentAccountDetail> ad)

addAccountDetail

public void addAccountDetail(PaymentAccountDetail pad)

deleteAccountDetail

public void deleteAccountDetail(PaymentAccountDetail pad)

getNotes

public List<PaymentNoteText> getNotes()

setNotes

public void setNotes(List<PaymentNoteText> n)

addNote

public void addNote(PaymentNoteText pnt)

addPaymentText

public void addPaymentText(String paymentText)

Constructs a new PaymentNoteText for the given payment text and adds to the detail List

Parameters:

paymentText - note text

deleteNote

public void deleteNote(PaymentNoteText pnt)

getId

public org.kuali.rice.kns.util.KualiInteger getId()

Returns:

getCustPaymentDocNbr

public String getCustPaymentDocNbr()

Returns:

getInvoiceNbr

public String getInvoiceNbr()

Returns:

getInvTotDiscountAmount

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

Returns:

getInvTotOtherCreditAmount

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

Returns:

getInvTotOtherDebitAmount

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

Returns:

getInvTotShipAmount

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

Returns:

getNetPaymentAmount

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

Returns:

getOrganizationDocNbr

public String getOrganizationDocNbr()

Returns:

getOrigInvoiceAmount

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

Returns:

getPurchaseOrderNbr

public String getPurchaseOrderNbr()

Returns:

getRequisitionNbr

public String getRequisitionNbr()

Returns:

getPaymentGroup

public PaymentGroup getPaymentGroup()

Returns:

Returns the paymentGroup.

setCustPaymentDocNbr

public void setCustPaymentDocNbr(String string)

Parameters:

string -

setId

public void setId(org.kuali.rice.kns.util.KualiInteger integer)

Parameters:

integer -

setInvoiceNbr

public void setInvoiceNbr(String string)

Parameters:

string -

setInvTotDiscountAmount

public void setInvTotDiscountAmount(org.kuali.rice.kns.util.KualiDecimal decimal)

Parameters:

decimal -

setInvTotDiscountAmount

public void setInvTotDiscountAmount(String decimal)

setInvTotOtherCreditAmount

public void setInvTotOtherCreditAmount(org.kuali.rice.kns.util.KualiDecimal decimal)

Parameters:

decimal -

setInvTotOtherCreditAmount

public void setInvTotOtherCreditAmount(String decimal)

setInvTotOtherDebitAmount

public void setInvTotOtherDebitAmount(org.kuali.rice.kns.util.KualiDecimal decimal)

Parameters:

decimal -

setInvTotOtherDebitAmount

public void setInvTotOtherDebitAmount(String decimal)

setInvTotShipAmount

public void setInvTotShipAmount(org.kuali.rice.kns.util.KualiDecimal decimal)

Parameters:

decimal -

setInvTotShipAmount

public void setInvTotShipAmount(String decimal)

setNetPaymentAmount

public void setNetPaymentAmount(org.kuali.rice.kns.util.KualiDecimal decimal)

Parameters:

decimal -

setNetPaymentAmount

public void setNetPaymentAmount(String decimal)

setOrganizationDocNbr

public void setOrganizationDocNbr(String string)

Parameters:

string -

setOrigInvoiceAmount

public void setOrigInvoiceAmount(org.kuali.rice.kns.util.KualiDecimal decimal)

Parameters:

decimal -

setOrigInvoiceAmount

public void setOrigInvoiceAmount(String decimal)

setPurchaseOrderNbr

public void setPurchaseOrderNbr(String string)

Parameters:

string -

setRequisitionNbr

public void setRequisitionNbr(String string)

Parameters:

string -

getFinancialDocumentTypeCode

public String getFinancialDocumentTypeCode()

Returns:

Returns the financialDocumentTypeCode.

setFinancialDocumentTypeCode

public void setFinancialDocumentTypeCode(String financialDocumentTypeCode)

Parameters:

financialDocumentTypeCode - The financialDocumentTypeCode to set.

getPrimaryCancelledPayment

public Boolean getPrimaryCancelledPayment()

Returns:

Returns the primaryCancelledPayment.

setPrimaryCancelledPayment

public void setPrimaryCancelledPayment(Boolean primaryCancelledPayment)

Parameters:

primaryCancelledPayment - The primaryCancelledPayment to set.

setPaymentGroup

public void setPaymentGroup(PaymentGroup paymentGroup)

Parameters:

paymentGroup - The paymentGroup to set.

getPaymentGroupId

public org.kuali.rice.kns.util.KualiInteger getPaymentGroupId()

Gets the paymentGroupId attribute.

Returns:

Returns the paymentGroupId.

setPaymentGroupId

public void setPaymentGroupId(org.kuali.rice.kns.util.KualiInteger paymentGroupId)

Sets the paymentGroupId attribute value.

Parameters:

paymentGroupId - The paymentGroupId to set.

getFinancialSystemOriginCode

public String getFinancialSystemOriginCode()

Gets the financialSystemOriginCode attribute.

Returns:

Returns the financialSystemOriginCode.

setFinancialSystemOriginCode

public void setFinancialSystemOriginCode(String financialSystemOriginCode)

Sets the financialSystemOriginCode attribute value.

Parameters:

financialSystemOriginCode - The financialSystemOriginCode to set.

getNotesText

public String getNotesText()

This method returns a String representation of the payment detail notes

Returns:

the String representation of the payment detail notes

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

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

See Also:

BusinessObjectBase.toStringMapper()

getNbrOfPaymentsInPaymentGroup

public int getNbrOfPaymentsInPaymentGroup()

This method returns the number of payments in the payment group associated with this payment detail.

Returns:

the number of payments in the payment group

getNbrOfPaymentsInDisbursement

public int getNbrOfPaymentsInDisbursement()

This method returns the number of payments in the disbursement associated with this payment detail.

Returns:

the number of payments in the disbursement