org.kuali.kfs.fp.document
Class CreditCardReceiptDocument

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.document.DocumentBase
              org.kuali.rice.kns.document.TransactionalDocumentBase
                  org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      org.kuali.kfs.sys.document.LedgerPostingDocumentBase
                          org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase
                              org.kuali.kfs.sys.document.AccountingDocumentBase
                                  org.kuali.kfs.fp.document.CashReceiptFamilyBase
                                      org.kuali.kfs.fp.document.CreditCardReceiptDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, CapitalAssetEditable, AccountingDocument, AmountTotaling, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Copyable, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument

public class CreditCardReceiptDocument
extends CashReceiptFamilyBase
implements org.kuali.rice.kns.document.Copyable, AmountTotaling

This is the business object that represents the CreditCardReceipt document in Kuali. This is a transactional document that will eventually post transactions to the G/L. It integrates with workflow. Since a Credit Card Receipt is a one sided transactional document, only accepting funds into the university, the accounting line data will be held in the source accounting line data structure only.

See Also:

Serialized Form

Field Summary

protected List<CreditCardDetail>	creditCardReceipts
protected Integer	nextCcCrLineNumber
protected org.kuali.rice.kns.util.KualiDecimal	totalCreditCardAmount

Fields inherited from class org.kuali.kfs.fp.document.CashReceiptFamilyBase

campusLocationCode, capitalAssetInformation, depositDate, LOG

Fields inherited from class org.kuali.kfs.sys.document.AccountingDocumentBase

dataDictionaryEntry, nextSourceLineNumber, nextTargetLineNumber, sourceAccountingLineClass, sourceAccountingLines, targetAccountingLineClass, targetAccountingLines

Fields inherited from class org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase

generalLedgerPendingEntries

Fields inherited from class org.kuali.kfs.sys.document.LedgerPostingDocumentBase

accountingPeriod, accountingPeriodService, checkPostingYearForCopy, dataDictionaryService, dateTimeService, postingPeriodCode, postingYear

Fields inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase

documentHeader

Fields inherited from class org.kuali.rice.kns.document.DocumentBase

documentBusinessObject, documentNumber

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

extension, versionNumber

Constructor Summary

CreditCardReceiptDocument()
Default constructor that calls super.

Method Summary

void	addCreditCardReceipt(CreditCardDetail creditCardReceiptDetail) Adds a new credit card receipt to the list.
List	buildListOfDeletionAwareLists() Overrides super to call super and then also add in the new list of credit card receipts that have to be managed.
org.kuali.rice.kns.util.KualiDecimal	calculateCreditCardReceiptTotal() This method returns the sum of all of the credit card receipts for this document.
boolean	documentPerformsSufficientFundsCheck() Documents in the CashReceiptFamily do not perform Sufficient Funds checking
void	doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent) Override to call super and then iterate over all GLPEs and update the approved code appropriately.
boolean	generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Generates bank offset GLPEs for deposits, if enabled.
CreditCardDetail	getCreditCardReceipt(int index) Retrieve a particular credit card receipt at a given index in the list of credit card receipts.
List<CreditCardDetail>	getCreditCardReceipts() Gets the list of credit card receipts which is a list of CreditCardDetail business objects.
String	getCurrencyFormattedTotalCreditCardAmount() This method returns the credit card total amount as a currency formatted string.
Integer	getNextCcCrLineNumber()
protected Bank	getOffsetBank() Returns the default bank code for Credit Card Receipt documents.
org.kuali.rice.kns.util.KualiDecimal	getTotalCreditCardAmount() Gets the total credit card amount.
org.kuali.rice.kns.util.KualiDecimal	getTotalDollarAmount() This method returns the overall total of the document - the credit card total.
void	postProcessSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)
void	prepareNewCreditCardReceipt(CreditCardDetail creditCardReceiptDetail) This is a helper method that automatically populates document specfic information into the credit card receipt (CreditCardDetail) instance.
void	removeCreditCardReceipt(int index) This method removes a credit card receipt from the list and updates the total appropriately.
void	setCreditCardReceipts(List<CreditCardDetail> creditCardReceipts) Sets the credit card receipts list.
void	setNextCcCrLineNumber(Integer nextCcCrLineNumber)
void	setTotalCreditCardAmount(org.kuali.rice.kns.util.KualiDecimal creditCardAmount) Sets the total credit card amount which is the sum of all credit card receipts on this document.

Methods inherited from class org.kuali.kfs.fp.document.CashReceiptFamilyBase

customizeExplicitGeneralLedgerPendingEntry, getCampusLocationCode, getCapitalAssetInformation, getCapitalAssetManagementModuleService, getDepositDate, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLinesSectionTitle, getTargetTotal, isDebit, setCampusLocationCode, setCapitalAssetInformation, setDepositDate

Methods inherited from class org.kuali.kfs.sys.document.AccountingDocumentBase

addSourceAccountingLine, addTargetAccountingLine, buildAccountingLineMap, copyAccountingLines, customizeOffsetGeneralLedgerPendingEntry, generateEvents, generateGeneralLedgerPendingEntries, generateSaveEvents, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesForComparison, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesForComparison, prepareForSave, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, toErrorCorrection, updatePostingYearForAccountingLines

Methods inherited from class org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, removeGeneralLedgerPendingEntries, setGeneralLedgerPendingEntries

Methods inherited from class org.kuali.kfs.sys.document.LedgerPostingDocumentBase

createInitialAccountingPeriod, getAccountingPeriod, getAccountingPeriodService, getDataDictionaryService, getDateTimeService, getFinancialDocumentTypeCode, getPostingPeriodCode, getPostingYear, retrieveCurrentAccountingPeriod, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase

answerSplitNodeQuestion, getDocumentHeader, prepareForSave, processAfterRetrieve, setDocumentHeader

Methods inherited from class org.kuali.rice.kns.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.kns.document.DocumentBase

addCopyErrorDocumentNote, addPessimisticLock, afterLookup, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setPessimisticLocks, toString, toStringBuilder, toStringMapper, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

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

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

prepareForWorkflow

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.document.Copyable

toCopy

Methods inherited from interface org.kuali.kfs.sys.document.GeneralLedgerPostingDocument

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

Methods inherited from interface org.kuali.kfs.sys.document.LedgerPostingDocument

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.kfs.sys.document.FinancialSystemTransactionalDocument

answerSplitNodeQuestion, getDocumentHeader

Methods inherited from interface org.kuali.rice.kns.document.Document

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.kns.bo.PersistableBusinessObject

addNote, 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

Methods inherited from interface org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getPostingYear

Field Detail

creditCardReceipts

protected List<CreditCardDetail> creditCardReceipts

nextCcCrLineNumber

protected Integer nextCcCrLineNumber

totalCreditCardAmount

protected org.kuali.rice.kns.util.KualiDecimal totalCreditCardAmount

Constructor Detail

CreditCardReceiptDocument

public CreditCardReceiptDocument()

Default constructor that calls super.

Method Detail

documentPerformsSufficientFundsCheck

public boolean documentPerformsSufficientFundsCheck()

Description copied from class: CashReceiptFamilyBase

Documents in the CashReceiptFamily do not perform Sufficient Funds checking

Overrides:

documentPerformsSufficientFundsCheck in class CashReceiptFamilyBase

Returns:

See Also:

GeneralLedgerPostingDocumentBase.documentPerformsSufficientFundsCheck()

getTotalCreditCardAmount

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

Gets the total credit card amount.

Returns:

KualiDecimal

getCurrencyFormattedTotalCreditCardAmount

public String getCurrencyFormattedTotalCreditCardAmount()

This method returns the credit card total amount as a currency formatted string.

Returns:

String

setTotalCreditCardAmount

public void setTotalCreditCardAmount(org.kuali.rice.kns.util.KualiDecimal creditCardAmount)

Sets the total credit card amount which is the sum of all credit card receipts on this document.

Parameters:

creditCardAmount -

getCreditCardReceipts

public List<CreditCardDetail> getCreditCardReceipts()

Gets the list of credit card receipts which is a list of CreditCardDetail business objects.

Returns:

List

setCreditCardReceipts

public void setCreditCardReceipts(List<CreditCardDetail> creditCardReceipts)

Sets the credit card receipts list.

Parameters:

creditCardReceipts -

addCreditCardReceipt

public void addCreditCardReceipt(CreditCardDetail creditCardReceiptDetail)

Adds a new credit card receipt to the list.

Parameters:

creditCardReceiptDetail -

prepareNewCreditCardReceipt

public final void prepareNewCreditCardReceipt(CreditCardDetail creditCardReceiptDetail)

This is a helper method that automatically populates document specfic information into the credit card receipt (CreditCardDetail) instance.

Parameters:

creditCardReceiptDetail -

getCreditCardReceipt

public CreditCardDetail getCreditCardReceipt(int index)

Retrieve a particular credit card receipt at a given index in the list of credit card receipts.

Parameters:

index -

Returns:

CreditCardReceiptDetail

removeCreditCardReceipt

public void removeCreditCardReceipt(int index)

This method removes a credit card receipt from the list and updates the total appropriately.

Parameters:

index -

getNextCcCrLineNumber

public Integer getNextCcCrLineNumber()

Returns:

Integer

setNextCcCrLineNumber

public void setNextCcCrLineNumber(Integer nextCcCrLineNumber)

Parameters:

nextCcCrLineNumber -

getTotalDollarAmount

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

This method returns the overall total of the document - the credit card total.

Specified by:

getTotalDollarAmount in interface AmountTotaling

Overrides:

getTotalDollarAmount in class AccountingDocumentBase

Returns:

KualiDecimal

See Also:

AccountingDocumentBase.getTotalDollarAmount()

calculateCreditCardReceiptTotal

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

This method returns the sum of all of the credit card receipts for this document.

Returns:

KualiDecimal

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Overrides super to call super and then also add in the new list of credit card receipts that have to be managed.

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.kns.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class CashReceiptFamilyBase

See Also:

PersistableBusinessObjectBase.buildListOfDeletionAwareLists()

generateDocumentGeneralLedgerPendingEntries

public boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Generates bank offset GLPEs for deposits, if enabled.

Specified by:

generateDocumentGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Overrides:

generateDocumentGeneralLedgerPendingEntries in class AccountingDocumentBase

Parameters:

financialDocument - submitted accounting document

sequenceHelper - helper class for keep track of sequence for GLPEs

Returns:

true if generation of GLPE's is successful for credit card receipt document

See Also:

org.kuali.rice.kns.rule.GenerateGeneralLedgerDocumentPendingEntriesRule#processGenerateDocumentGeneralLedgerPendingEntries(org.kuali.rice.kns.document.FinancialDocument,org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

getOffsetBank

protected Bank getOffsetBank()

Returns the default bank code for Credit Card Receipt documents.

postProcessSave

public void postProcessSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)

Specified by:

postProcessSave in interface org.kuali.rice.kns.document.Document

Overrides:

postProcessSave in class org.kuali.rice.kns.document.DocumentBase

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)

Description copied from class: GeneralLedgerPostingDocumentBase

Override to call super and then iterate over all GLPEs and update the approved code appropriately.

Specified by:

doRouteStatusChange in interface org.kuali.rice.kns.document.Document

Overrides:

doRouteStatusChange in class GeneralLedgerPostingDocumentBase

See Also:

Document#doRouteStatusChange()