org.kuali.kfs.pdp.businessobject
Class PaymentGroup

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.PaymentGroup

All Implemented Interfaces:

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

public class PaymentGroup
extends TimestampedBusinessObjectBase

This class represents the PaymentGroup

See Also:

Serialized Form

Field Summary

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

extension, versionNumber

Constructor Summary

PaymentGroup()
Constructs a PaymentGroup.java.

Method Summary

void	addPaymentDetails(PaymentDetail pgh) This method adds a paymentDetail
void	addPaymentGroupHistory(PaymentGroupHistory pd) This method adds a paymentGroupHistory
void	deletePaymentDetails(PaymentDetail pgh)
void	deletePaymentGroupHistory(PaymentGroupHistory pd) This method deletes a paymentGroupHistory
AchAccountNumber	getAchAccountNumber()
String	getAchAccountType()
String	getAchBankRoutingNbr()
String	getAdviceEmailAddress()
Timestamp	getAdviceEmailSentDate() Gets the adviceEmailSentDate attribute.
String	getAlternatePayeeId()
String	getAlternatePayeeIdTypeCd()
Bank	getBank()
String	getBankCode() Gets the bankCode attribute.
Batch	getBatch()
org.kuali.rice.kns.util.KualiInteger	getBatchId() Gets the batchId attribute.
Boolean	getCampusAddress()
String	getCity()
boolean	getCombineGroups()
String	getCountry()
org.kuali.rice.kns.util.KualiDecimal	getCreditMemoAmount()
String	getCreditMemoNbr()
String	getCustomerInstitutionNumber()
Date	getDisbursementDate() This method gets the disbursementDate.
org.kuali.rice.kns.util.KualiInteger	getDisbursementNbr()
DisbursementType	getDisbursementType()
String	getDisbursementTypeCode()
Boolean	getEmployeeIndicator()
Timestamp	getEpicPaymentCancelledExtractedDate()
Timestamp	getEpicPaymentPaidExtractedDate()
org.kuali.rice.kns.util.KualiInteger	getId()
String	getLine1Address()
String	getLine2Address()
String	getLine3Address()
String	getLine4Address()
org.kuali.rice.kns.util.KualiDecimal	getNetPaymentAmount() Get the total of all the detail items
int	getNoteLines() This method gets the notle lines
Boolean	getNraPayment()
String	getPayeeId()
String	getPayeeIdTypeCd()
String	getPayeeIdTypeDesc() This method gets the payeeIdTypeDesc
String	getPayeeName()
String	getPayeeOwnerCd()
Date	getPaymentDate()
List<PaymentDetail>	getPaymentDetails()
List<PaymentGroupHistory>	getPaymentGroupHistory()
PaymentStatus	getPaymentStatus()
String	getPaymentStatusCode() This method gets the paymentStatusCode
String	getPaymentStatusCodeWithHistory()
String	getPhysCampusProcessCd()
PaymentProcess	getProcess()
org.kuali.rice.kns.util.KualiInteger	getProcessId()
Boolean	getProcessImmediate()
Boolean	getPymtAttachment()
Boolean	getPymtSpecialHandling()
String	getSortValue() This method gets the sortValue
String	getState()
String	getStreet() This method gets a string representation of the address lines
Boolean	getTaxablePayment()
String	getZipCd()
boolean	isDailyReportAttachment() This method gets the dailyReportAttachment
boolean	isDailyReportSpecialHandling() This method gets the dailyReportSpecialHandling
void	setAchAccountNumber(AchAccountNumber aan) This method sets the achAccountNumber
void	setAchAccountType(String achAccountType)
void	setAchBankRoutingNbr(String s)
void	setAdviceEmailAddress(String string)
void	setAdviceEmailSentDate(Timestamp adviceEmailSentDate) Sets the adviceEmailSentDate attribute value.
void	setAlternatePayeeId(String string)
void	setAlternatePayeeIdTypeCd(String string)
void	setBank(Bank bank)
void	setBankCode(String bankCode) Sets the bankCode attribute value.
void	setBatch(Batch b)
void	setBatchId(org.kuali.rice.kns.util.KualiInteger batchId) Sets the batchId attribute value.
void	setCampusAddress(Boolean boolean1)
void	setCity(String city)
void	setCombineGroups(boolean combineGroups)
void	setCountry(String country)
void	setCreditMemoAmount(org.kuali.rice.kns.util.KualiDecimal decimal)
void	setCreditMemoAmount(String decimal)
void	setCreditMemoNbr(String string)
void	setCustomerInstitutionNumber(String string)
void	setDisbursementDate(Date timestamp)
void	setDisbursementDate(String disbursementDate) This method sets disbursementDate.
void	setDisbursementNbr(org.kuali.rice.kns.util.KualiInteger integer)
void	setDisbursementNbr(String integer)
void	setDisbursementType(DisbursementType dt)
void	setDisbursementTypeCode(String disbursementTypeCode)
void	setEmployeeIndicator(Boolean boolean1)
void	setEpicPaymentCancelledExtractedDate(Timestamp epicPaymentCancelledExtractedDate)
void	setEpicPaymentPaidExtractedDate(Timestamp epicPaymentPaidExtractedDate)
void	setId_type(String idType)
void	setId(org.kuali.rice.kns.util.KualiInteger integer)
void	setLine1Address(String string)
void	setLine2Address(String string)
void	setLine3Address(String string)
void	setLine4Address(String string)
void	setNraPayment(Boolean boolean1)
void	setPayeeId(String string)
void	setPayeeIdTypeCd(String string)
void	setPayeeName(String string)
void	setPayeeOwnerCd(String string)
void	setPaymentDate(Date timestamp)
void	setPaymentDate(String paymentDate) Takes a String and attempt to format as Timestamp
void	setPaymentDetails(List<PaymentDetail> paymentDetail) This method sets the payment details list
void	setPaymentGroupHistory(List<PaymentGroupHistory> paymentGroupHistory) This method sets the payment group history list
void	setPaymentStatus(PaymentStatus stat)
void	setPaymentStatusCode(String paymentStatusCode)
void	setPhysCampusProcessCd(String string)
void	setProcess(PaymentProcess p)
void	setProcessId(org.kuali.rice.kns.util.KualiInteger processId)
void	setProcessImmediate(Boolean boolean1)
void	setPymtAttachment(Boolean boolean1)
void	setPymtSpecialHandling(Boolean pymtSpecialHandling)
void	setSortValue(int sortGroupId) This method sets the sort value
void	setState(String state)
void	setTaxablePayment(Boolean boolean1)
void	setZipCd(String string)
String	toStringKey()
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

PaymentGroup

public PaymentGroup()

Constructs a PaymentGroup.java.

Method Detail

isDailyReportSpecialHandling

public boolean isDailyReportSpecialHandling()

This method gets the dailyReportSpecialHandling

Returns:

dailyReportSpecialHandling

isDailyReportAttachment

public boolean isDailyReportAttachment()

This method gets the dailyReportAttachment

Returns:

dailyReportAttachment

getPaymentStatusCode

public String getPaymentStatusCode()

This method gets the paymentStatusCode

Returns:

paymentStatusCode

getPaymentStatusCodeWithHistory

public String getPaymentStatusCodeWithHistory()

Returns:

String containing the payment status code and indication or cancel/reissued payments or stale payments

getNoteLines

public int getNoteLines()

This method gets the notle lines

Returns:

the note lines

getNetPaymentAmount

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

Get the total of all the detail items

Returns:

getPaymentDetails

public List<PaymentDetail> getPaymentDetails()

setPaymentDetails

public void setPaymentDetails(List<PaymentDetail> paymentDetail)

This method sets the payment details list

Parameters:

paymentDetail -

addPaymentDetails

public void addPaymentDetails(PaymentDetail pgh)

This method adds a paymentDetail

Parameters:

pgh - the payments detail to be added

deletePaymentDetails

public void deletePaymentDetails(PaymentDetail pgh)

getPaymentGroupHistory

public List<PaymentGroupHistory> getPaymentGroupHistory()

setPaymentGroupHistory

public void setPaymentGroupHistory(List<PaymentGroupHistory> paymentGroupHistory)

This method sets the payment group history list

Parameters:

paymentGroupHistory -

addPaymentGroupHistory

public void addPaymentGroupHistory(PaymentGroupHistory pd)

This method adds a paymentGroupHistory

Parameters:

pd - the paymentGroupHistory to be added

deletePaymentGroupHistory

public void deletePaymentGroupHistory(PaymentGroupHistory pd)

This method deletes a paymentGroupHistory

Parameters:

pd - the paymentGroupHistory to be deleted

getId

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

Returns:

getAchAccountNumber

public AchAccountNumber getAchAccountNumber()

Returns:

setAchAccountNumber

public void setAchAccountNumber(AchAccountNumber aan)

This method sets the achAccountNumber

Parameters:

aan -

getSortValue

public String getSortValue()

This method gets the sortValue

Returns:

sortValue

setSortValue

public void setSortValue(int sortGroupId)

This method sets the sort value

Parameters:

sortGroupId -

getCity

public String getCity()

Returns:

Returns the city.

setCity

public void setCity(String city)

Parameters:

city - The city to set.

getCombineGroups

public boolean getCombineGroups()

setCombineGroups

public void setCombineGroups(boolean combineGroups)

getCountry

public String getCountry()

Returns:

Returns the country.

setCountry

public void setCountry(String country)

Parameters:

country - The country to set.

getState

public String getState()

Returns:

Returns the state.

setState

public void setState(String state)

Parameters:

state - The state to set.

getAchBankRoutingNbr

public String getAchBankRoutingNbr()

Returns:

getAdviceEmailAddress

public String getAdviceEmailAddress()

Returns:

getAlternatePayeeId

public String getAlternatePayeeId()

Returns:

getAlternatePayeeIdTypeCd

public String getAlternatePayeeIdTypeCd()

Returns:

getBank

public Bank getBank()

Returns:

getBatch

public Batch getBatch()

Returns:

getBankCode

public String getBankCode()

Gets the bankCode attribute.

Returns:

Returns the bankCode.

setBankCode

public void setBankCode(String bankCode)

Sets the bankCode attribute value.

Parameters:

bankCode - The bankCode to set.

getCampusAddress

public Boolean getCampusAddress()

Returns:

getCreditMemoAmount

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

Returns:

getCreditMemoNbr

public String getCreditMemoNbr()

Returns:

getCustomerInstitutionNumber

public String getCustomerInstitutionNumber()

getDisbursementDate

public Date getDisbursementDate()

This method gets the disbursementDate.

Returns:

disbursementDate

getDisbursementNbr

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

Returns:

getDisbursementType

public DisbursementType getDisbursementType()

Returns:

getEmployeeIndicator

public Boolean getEmployeeIndicator()

getLine1Address

public String getLine1Address()

Returns:

getLine2Address

public String getLine2Address()

Returns:

getLine3Address

public String getLine3Address()

Returns:

getLine4Address

public String getLine4Address()

Returns:

getNraPayment

public Boolean getNraPayment()

Returns:

getPayeeId

public String getPayeeId()

Returns:

getPayeeIdTypeCd

public String getPayeeIdTypeCd()

Returns:

getPayeeName

public String getPayeeName()

Returns:

getPayeeOwnerCd

public String getPayeeOwnerCd()

Returns:

getPaymentDate

public Date getPaymentDate()

Returns:

getPaymentStatus

public PaymentStatus getPaymentStatus()

Returns:

getPhysCampusProcessCd

public String getPhysCampusProcessCd()

Returns:

getProcess

public PaymentProcess getProcess()

Returns:

getProcessImmediate

public Boolean getProcessImmediate()

Returns:

getPymtAttachment

public Boolean getPymtAttachment()

Returns:

getPymtSpecialHandling

public Boolean getPymtSpecialHandling()

Returns:

getTaxablePayment

public Boolean getTaxablePayment()

Returns:

getZipCd

public String getZipCd()

Returns:

setAchBankRoutingNbr

public void setAchBankRoutingNbr(String s)

Parameters:

integer -

setAdviceEmailAddress

public void setAdviceEmailAddress(String string)

Parameters:

string -

setAlternatePayeeId

public void setAlternatePayeeId(String string)

Parameters:

string -

setAlternatePayeeIdTypeCd

public void setAlternatePayeeIdTypeCd(String string)

Parameters:

string -

setBank

public void setBank(Bank bank)

Parameters:

integer -

setBatch

public void setBatch(Batch b)

Parameters:

integer -

setCampusAddress

public void setCampusAddress(Boolean boolean1)

Parameters:

boolean1 -

setCreditMemoAmount

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

Parameters:

decimal -

setCreditMemoAmount

public void setCreditMemoAmount(String decimal)

setCreditMemoNbr

public void setCreditMemoNbr(String string)

Parameters:

string -

setCustomerInstitutionNumber

public void setCustomerInstitutionNumber(String string)

Parameters:

string -

setDisbursementDate

public void setDisbursementDate(Date timestamp)

Parameters:

timestamp -

setDisbursementDate

public void setDisbursementDate(String disbursementDate)
                         throws ParseException

This method sets disbursementDate.

Parameters:

disbursementDate - a string representing the disbursementDate

Throws:

ParseException

setDisbursementNbr

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

Parameters:

integer -

setDisbursementNbr

public void setDisbursementNbr(String integer)

setDisbursementType

public void setDisbursementType(DisbursementType dt)

Parameters:

string -

setId

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

Parameters:

integer -

setEmployeeIndicator

public void setEmployeeIndicator(Boolean boolean1)

Parameters:

boolean1 -

setLine1Address

public void setLine1Address(String string)

Parameters:

string -

setLine2Address

public void setLine2Address(String string)

Parameters:

string -

setLine3Address

public void setLine3Address(String string)

Parameters:

string -

setLine4Address

public void setLine4Address(String string)

Parameters:

string -

setNraPayment

public void setNraPayment(Boolean boolean1)

Parameters:

boolean1 -

setPayeeId

public void setPayeeId(String string)

Parameters:

string -

setPayeeIdTypeCd

public void setPayeeIdTypeCd(String string)

Parameters:

string -

setPayeeName

public void setPayeeName(String string)

Parameters:

string -

setPayeeOwnerCd

public void setPayeeOwnerCd(String string)

Parameters:

string -

setPaymentDate

public void setPaymentDate(Date timestamp)

Parameters:

timestamp -

setPaymentDate

public void setPaymentDate(String paymentDate)
                    throws ParseException

Takes a String and attempt to format as Timestamp

Parameters:

paymentDate - Timestamp as string

Throws:

ParseException

setPaymentStatus

public void setPaymentStatus(PaymentStatus stat)

Parameters:

string -

setPhysCampusProcessCd

public void setPhysCampusProcessCd(String string)

Parameters:

string -

setProcess

public void setProcess(PaymentProcess p)

Parameters:

integer -

setProcessImmediate

public void setProcessImmediate(Boolean boolean1)

Parameters:

boolean1 -

setPymtAttachment

public void setPymtAttachment(Boolean boolean1)

Parameters:

boolean1 -

setTaxablePayment

public void setTaxablePayment(Boolean boolean1)

Parameters:

boolean1 -

setZipCd

public void setZipCd(String string)

Parameters:

string -

setPymtSpecialHandling

public void setPymtSpecialHandling(Boolean pymtSpecialHandling)

Parameters:

string -

toStringKey

public String toStringKey()

getAchAccountType

public String getAchAccountType()

Returns:

Returns the achAccountType.

setAchAccountType

public void setAchAccountType(String achAccountType)

Parameters:

achAccountType - The achAccountType to set.

getEpicPaymentCancelledExtractedDate

public Timestamp getEpicPaymentCancelledExtractedDate()

setEpicPaymentCancelledExtractedDate

public void setEpicPaymentCancelledExtractedDate(Timestamp epicPaymentCancelledExtractedDate)

getEpicPaymentPaidExtractedDate

public Timestamp getEpicPaymentPaidExtractedDate()

setEpicPaymentPaidExtractedDate

public void setEpicPaymentPaidExtractedDate(Timestamp epicPaymentPaidExtractedDate)

getBatchId

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

Gets the batchId attribute.

Returns:

Returns the batchId.

setBatchId

public void setBatchId(org.kuali.rice.kns.util.KualiInteger batchId)

Sets the batchId attribute value.

Parameters:

batchId - The batchId to set.

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

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

getDisbursementTypeCode

public String getDisbursementTypeCode()

setDisbursementTypeCode

public void setDisbursementTypeCode(String disbursementTypeCode)

getProcessId

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

setProcessId

public void setProcessId(org.kuali.rice.kns.util.KualiInteger processId)

setPaymentStatusCode

public void setPaymentStatusCode(String paymentStatusCode)

setId_type

public void setId_type(String idType)

getAdviceEmailSentDate

public Timestamp getAdviceEmailSentDate()

Gets the adviceEmailSentDate attribute.

Returns:

Returns the adviceEmailSentDate.

setAdviceEmailSentDate

public void setAdviceEmailSentDate(Timestamp adviceEmailSentDate)

Sets the adviceEmailSentDate attribute value.

Parameters:

adviceEmailSentDate - The adviceEmailSentDate to set.

getStreet

public String getStreet()

This method gets a string representation of the address lines

Returns:

the street as a combined representation of the address lines

getPayeeIdTypeDesc

public String getPayeeIdTypeDesc()

This method gets the payeeIdTypeDesc

Returns:

the payeeIdTypeDesc