org.kuali.kfs.sys.businessobject
Class ElectronicPaymentClaim

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.kfs.sys.businessobject.ElectronicPaymentClaim

All Implemented Interfaces:

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

public class ElectronicPaymentClaim
extends org.kuali.rice.kns.bo.PersistableBusinessObjectBase

This class is used to represent an electronic payment claim.

See Also:

Serialized Form

Nested Class Summary

static class

ElectronicPaymentClaim.ClaimStatusCodes

Field Summary

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

extension, versionNumber

Constructor Summary

ElectronicPaymentClaim()
Default constructor.

Method Summary

String	getDocumentNumber() Gets the documentNumber attribute.
String	getElectronicPaymentClaimRepresentation() Returns the String representation for an Electronic Payment Claim record, to be used by the claimed checkbox
Integer	getFinancialDocumentLineNumber() Gets the financialDocumentLineNumber attribute.
AccountingPeriod	getFinancialDocumentPostingPeriod() Gets the financialDocumentPostingPeriod attribute.
String	getFinancialDocumentPostingPeriodCode() Gets the financialDocumentPostingPeriodCode attribute.
Integer	getFinancialDocumentPostingYear() Gets the financialDocumentPostingYear attribute.
SourceAccountingLine	getGeneratingAccountingLine() Returns the accounting line on the generating Advance Deposit document for the transaction which generated this record
AdvanceDepositDetail	getGeneratingAdvanceDepositDetail() Returns the AdvanceDepositDetail for the first deposit detail on this document
AdvanceDepositDocument	getGeneratingDocument() Gets the generatingDocument attribute.
org.kuali.rice.kns.bo.DocumentHeader	getGeneratingDocumentHeader() Gets the generatingDocumentHeader attribute.
String	getPaymentClaimStatus()
String	getPaymentClaimStatusCode() Gets the paymentClaimStatusCode attribute.
String	getReferenceFinancialDocumentNumber() Gets the referenceFinancialDocumentNumber attribute.
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute.
void	setFinancialDocumentLineNumber(Integer financialDocumentLineNumber) Sets the financialDocumentLineNumber attribute.
void	setFinancialDocumentPostingPeriod(AccountingPeriod financialDocumentPostingPeriod) Sets the financialDocumentPostingPeriod attribute value.
void	setFinancialDocumentPostingPeriodCode(String financialDocumentPostingPeriodCode) Sets the financialDocumentPostingPeriodCode attribute.
void	setFinancialDocumentPostingYear(Integer financialDocumentPostingYear) Sets the financialDocumentPostingYear attribute.
void	setGeneratingDocumentHeader(org.kuali.rice.kns.bo.DocumentHeader generatingDocumentHeader) Deprecated.
void	setPaymentClaimStatusCode(String paymentClaimStatusCode) Sets the paymentClaimStatusCode attribute value.
void	setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber) Sets the referenceFinancialDocumentNumber 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.BusinessObject

prepareForWorkflow

Constructor Detail

ElectronicPaymentClaim

public ElectronicPaymentClaim()

Default constructor. It constructs.

Method Detail

getDocumentNumber

public String getDocumentNumber()

Gets the documentNumber attribute.

Returns:

Returns the documentNumber

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Sets the documentNumber attribute.

Parameters:

documentNumber - The documentNumber to set.

getFinancialDocumentLineNumber

public Integer getFinancialDocumentLineNumber()

Gets the financialDocumentLineNumber attribute.

Returns:

Returns the financialDocumentLineNumber

setFinancialDocumentLineNumber

public void setFinancialDocumentLineNumber(Integer financialDocumentLineNumber)

Sets the financialDocumentLineNumber attribute.

Parameters:

financialDocumentLineNumber - The financialDocumentLineNumber to set.

getReferenceFinancialDocumentNumber

public String getReferenceFinancialDocumentNumber()

Gets the referenceFinancialDocumentNumber attribute.

Returns:

Returns the referenceFinancialDocumentNumber

setReferenceFinancialDocumentNumber

public void setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber)

Sets the referenceFinancialDocumentNumber attribute.

Parameters:

referenceFinancialDocumentNumber - The referenceFinancialDocumentNumber to set.

getFinancialDocumentPostingYear

public Integer getFinancialDocumentPostingYear()

Gets the financialDocumentPostingYear attribute.

Returns:

Returns the financialDocumentPostingYear

setFinancialDocumentPostingYear

public void setFinancialDocumentPostingYear(Integer financialDocumentPostingYear)

Sets the financialDocumentPostingYear attribute.

Parameters:

financialDocumentPostingYear - The financialDocumentPostingYear to set.

getFinancialDocumentPostingPeriodCode

public String getFinancialDocumentPostingPeriodCode()

Gets the financialDocumentPostingPeriodCode attribute.

Returns:

Returns the financialDocumentPostingPeriodCode

setFinancialDocumentPostingPeriodCode

public void setFinancialDocumentPostingPeriodCode(String financialDocumentPostingPeriodCode)

Sets the financialDocumentPostingPeriodCode attribute.

Parameters:

financialDocumentPostingPeriodCode - The financialDocumentPostingPeriodCode to set.

getPaymentClaimStatusCode

public String getPaymentClaimStatusCode()

Gets the paymentClaimStatusCode attribute.

Returns:

Returns the paymentClaimStatusCode.

setPaymentClaimStatusCode

public void setPaymentClaimStatusCode(String paymentClaimStatusCode)

Sets the paymentClaimStatusCode attribute value.

Parameters:

paymentClaimStatusCode - The paymentClaimStatusCode to set.

getGeneratingDocument

public AdvanceDepositDocument getGeneratingDocument()

Gets the generatingDocument attribute.

Returns:

Returns the generatingDocument.

getGeneratingDocumentHeader

public org.kuali.rice.kns.bo.DocumentHeader getGeneratingDocumentHeader()

Gets the generatingDocumentHeader attribute.

Returns:

Returns the generatingDocumentHeader.

setGeneratingDocumentHeader

public void setGeneratingDocumentHeader(org.kuali.rice.kns.bo.DocumentHeader generatingDocumentHeader)

Deprecated.

Sets the generatingDocumentHeader attribute value.

Parameters:

generatingDocumentHeader - The generatingDocumentHeader to set.

getGeneratingAccountingLine

public SourceAccountingLine getGeneratingAccountingLine()

Returns the accounting line on the generating Advance Deposit document for the transaction which generated this record

Returns:

the accounting line that describes the transaction responsible for the creation of this record

getGeneratingAdvanceDepositDetail

public AdvanceDepositDetail getGeneratingAdvanceDepositDetail()

Returns the AdvanceDepositDetail for the first deposit detail on this document

Returns:

the advance deposit detail that describes the transaction responsible for the creation of this record

getFinancialDocumentPostingPeriod

public AccountingPeriod getFinancialDocumentPostingPeriod()

Gets the financialDocumentPostingPeriod attribute.

Returns:

Returns the financialDocumentPostingPeriod.

setFinancialDocumentPostingPeriod

public void setFinancialDocumentPostingPeriod(AccountingPeriod financialDocumentPostingPeriod)

Sets the financialDocumentPostingPeriod attribute value.

Parameters:

financialDocumentPostingPeriod - The financialDocumentPostingPeriod to set.

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

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

See Also:

BusinessObjectBase.toStringMapper()

getElectronicPaymentClaimRepresentation

public String getElectronicPaymentClaimRepresentation()

Returns the String representation for an Electronic Payment Claim record, to be used by the claimed checkbox

Parameters:

claim - a claim to get a String representation for

Returns:

the representation in the form of "{generating document number}::{generating document accounting line sequence number}"

getPaymentClaimStatus

public String getPaymentClaimStatus()

Returns:

a descriptive version of the paymentClaimStatusCode field