org.kuali.kfs.module.ar.document
Class CashControlDocument

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.module.ar.document.CashControlDocument

All Implemented Interfaces:

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

public class CashControlDocument
extends GeneralLedgerPostingDocumentBase
implements AmountTotaling, GeneralLedgerPendingEntrySource, ElectronicPaymentClaiming, GeneralLedgerPostingDocument

Author:

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

See Also:

Serialized Form

Field Summary

protected AccountsReceivableDocumentHeader	accountsReceivableDocumentHeader
protected Bank	bank
protected String	bankCode
protected List<CashControlDetail>	cashControlDetails
protected org.kuali.rice.kns.util.KualiDecimal	cashControlTotalAmount
protected PaymentMedium	customerPaymentMedium
protected String	customerPaymentMediumCode
protected List<ElectronicPaymentClaim>	electronicPaymentClaims
protected static String	GENERAL_LEDGER_POSTING_HELPER_BEAN_ID
protected List<GeneralLedgerPendingEntry>	generalLedgerPendingEntries
protected String	lockboxNumber
protected static org.apache.log4j.Logger	LOG
protected static String	NODE_ASSOCIATED_WITH_ELECTRONIC_PAYMENT
protected String	referenceFinancialDocumentNumber
protected AccountingPeriod	universityFiscalPeriod
protected String	universityFiscalPeriodCode
protected Integer	universityFiscalYear

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

CashControlDocument()
Default constructor.

Method Summary

void	addCashControlDetail(CashControlDetail cashControlDetail) This method adds a new cash control detail to the list
void	addPendingEntry(GeneralLedgerPendingEntry entry) Adds a GeneralLedgerPendingEntry to this document's list of pending entries
boolean	answerSplitNodeQuestion(String nodeName) Answers true when document payment medium is WIRE transfer
protected String	buildTransactionLedgerEntryDescriptionUsingRefOriginAndRefDocNumber(GeneralLedgerPendingEntrySourceDetail line) Builds an appropriately formatted string to be used for the transactionLedgerEntryDescription.
void	changeGeneralLedgerPendingEntriesApprovedStatusCode() This method set glpes status to approved
void	clearAnyGeneralLedgerPendingEntries() This resets this document's list of general ledger pending etnries, though it does not delete those entries (however, the GeneralLedgerPendingEntryService will in most cases when this method is called).
void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry)
boolean	customizeOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry)
void	declaimElectronicPaymentClaims() A method which is called when a document is disapproved or canceled, which removes the claim the document had on any ElectronicPaymentClaim records.
void	deleteCashControlDetail(int index) This method removes a cash control detail from the list
protected void	deleteCashControlDetailsFromDB()
boolean	generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Creates any GeneralLedgerPostingEntry's that are based on a document, not those based on GeneralLedgerPendingEntrySourceDetail entries
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) The Cash Control document doesn't generate general ledger pending entries based off of the accounting lines on the document
AccountsReceivableDocumentHeader	getAccountsReceivableDocumentHeader() Gets the accountsReceivableDocumentHeader attribute.
Bank	getBank()
String	getBankCode() Gets the bankCode attribute.
CashControlDetail	getCashControlDetail(int index) Retrieves a specific cash control detail from the list, by array index
List<CashControlDetail>	getCashControlDetails() Gets the cashControlDetails attribute.
org.kuali.rice.kns.util.KualiDecimal	getCashControlTotalAmount() Gets the cashControlTotalAmount attribute.
String	getChartOfAccountsCode() This is a helper method added to support workflow attribute configuration.
String	getCurrencyFormattedTotalCashControlAmount() This method returns the advance deposit total amount as a currency formatted string.
PaymentMedium	getCustomerPaymentMedium() Gets the customerPaymentMedium attribute.
String	getCustomerPaymentMediumCode() Gets the customerPaymentMediumCode attribute.
String	getDocumentNumber() Gets the documentNumber attribute.
List<ElectronicPaymentClaim>	getElectronicPaymentClaims() This method gets electronicPaymentClaims
String	getFinancialDocumentTypeCode() Returns the financial document type code for the given document, using the DataDictionaryService
Integer	getGeneralLedgerEntriesPostedCount() This is a method to check the count of gl entries according to the input fields and values
List<GeneralLedgerPendingEntry>	getGeneralLedgerPendingEntries() This method gets the glpes
GeneralLedgerPendingEntry	getGeneralLedgerPendingEntry(int index) This method gets an glpe by it's index in the list of glpes
org.kuali.rice.kns.util.KualiDecimal	getGeneralLedgerPendingEntryAmountForDetail(GeneralLedgerPendingEntrySourceDetail postable) A method to determine what the actual amount, based off of a GeneralLedgerPendingEntrySourceDetail, should be for the resultant GeneralLedgerPendingEntry
List<GeneralLedgerPendingEntrySourceDetail>	getGeneralLedgerPendingEntrySourceDetails() Returns a list of any GeneralLedgerPostables this helper has, to create GeneralLedgerPendingEntries
String	getLockboxNumber()
String	getOrganizationCode() This is a helper method added to support workflow attribute configuration.
Integer	getPostingYear()
org.kuali.rice.kns.document.Document	getReferenceFinancialDocument()
String	getReferenceFinancialDocumentNumber() Gets the referenceFinancialDocumentNumber attribute.
org.kuali.rice.kns.util.KualiDecimal	getTotalDollarAmount() This method returns the total dollar amount for the document.
AccountingPeriod	getUniversityFiscalPeriod() Gets the universityFiscalPeriod attribute.
String	getUniversityFiscalPeriodCode() Gets the universityFiscalPeriodCode attribute.
Integer	getUniversityFiscalYear() Gets the universityFiscalYear attribute.
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) This method determines if the passed in GeneralLedgerPendingEntrySourceDetail is a debit or not.
void	populateDocumentForRouting()
protected void	prepareCashControlDetail(CashControlDetail cashControlDetail) This is a helper method that automatically populates document specfic information into the cash control detail deposit (CashControlDetail) instance.
void	prepareForSave() If the document has a total amount, call method on document to get the total and set in doc header.
void	recalculateTotals()
void	setAccountsReceivableDocumentHeader(AccountsReceivableDocumentHeader accountsReceivableDocumentHeader) Sets the accountsReceivableDocumentHeader attribute value.
void	setBank(Bank bank)
void	setBankCode(String bankCode) Sets the bankCode attribute value.
void	setCashControlDetails(List<CashControlDetail> cashControlDetails) Sets the cashControlDetails attribute value.
void	setCashControlTotalAmount(org.kuali.rice.kns.util.KualiDecimal cashControlTotalAmount) Sets the cashControlTotalAmount attribute.
void	setCustomerPaymentMedium(PaymentMedium customerPaymentMedium) Sets the customerPaymentMedium attribute value.
void	setCustomerPaymentMediumCode(String customerPaymentMediumCode) Sets the customerPaymentMediumCode attribute.
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute.
void	setElectronicPaymentClaims(List<ElectronicPaymentClaim> electronicPaymentClaims) Deprecated.
void	setGeneralLedgerPendingEntries(List<GeneralLedgerPendingEntry> generalLedgerPendingEntries) This method sets the glpes
void	setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber) Sets the referenceFinancialDocumentNumber attribute.
void	setUniversityFiscalPeriod(AccountingPeriod universityFiscalPeriod) Deprecated.
void	setUniversityFiscalPeriodCode(String universityFiscalPeriodCode) Sets the universityFiscalPeriodCode attribute.
void	setUniversityFiscalYear(Integer universityFiscalYear) Sets the universityFiscalYear attribute.
protected LinkedHashMap	toStringMapper()

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

checkSufficientFunds, documentPerformsSufficientFundsCheck, doRouteStatusChange, getPendingLedgerEntriesForSufficientFundsChecking, prepareForSave, removeGeneralLedgerPendingEntries, toCopy, toErrorCorrection

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

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

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

getDocumentHeader, 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, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setNewDocumentHeader, setPessimisticLocks, toString, toStringBuilder, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

addNote, afterDelete, afterInsert, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, 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.kfs.sys.document.GeneralLedgerPendingEntrySource

getDocumentHeader

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

checkSufficientFunds, getPendingLedgerEntriesForSufficientFundsChecking

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

getAccountingPeriod, getPostingPeriodCode, setAccountingPeriod, setPostingPeriodCode, setPostingYear

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

getDocumentHeader

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

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

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

Field Detail

NODE_ASSOCIATED_WITH_ELECTRONIC_PAYMENT

protected static final String NODE_ASSOCIATED_WITH_ELECTRONIC_PAYMENT

See Also:

Constant Field Values

LOG

protected static org.apache.log4j.Logger LOG

referenceFinancialDocumentNumber

protected String referenceFinancialDocumentNumber

universityFiscalYear

protected Integer universityFiscalYear

universityFiscalPeriodCode

protected String universityFiscalPeriodCode

customerPaymentMediumCode

protected String customerPaymentMediumCode

cashControlTotalAmount

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

lockboxNumber

protected String lockboxNumber

bankCode

protected String bankCode

bank

protected Bank bank

customerPaymentMedium

protected PaymentMedium customerPaymentMedium

universityFiscalPeriod

protected AccountingPeriod universityFiscalPeriod

accountsReceivableDocumentHeader

protected AccountsReceivableDocumentHeader accountsReceivableDocumentHeader

cashControlDetails

protected List<CashControlDetail> cashControlDetails

generalLedgerPendingEntries

protected List<GeneralLedgerPendingEntry> generalLedgerPendingEntries

GENERAL_LEDGER_POSTING_HELPER_BEAN_ID

protected static final String GENERAL_LEDGER_POSTING_HELPER_BEAN_ID

See Also:

Constant Field Values

electronicPaymentClaims

protected List<ElectronicPaymentClaim> electronicPaymentClaims

Constructor Detail

CashControlDocument

public CashControlDocument()

Default constructor.

Method Detail

getDocumentNumber

public String getDocumentNumber()

Gets the documentNumber attribute.

Specified by:

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

Overrides:

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

Returns:

Returns the documentNumber

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Sets the documentNumber attribute.

Specified by:

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

Overrides:

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

Parameters:

documentNumber - The documentNumber 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.

getUniversityFiscalYear

public Integer getUniversityFiscalYear()

Gets the universityFiscalYear attribute.

Returns:

Returns the universityFiscalYear

setUniversityFiscalYear

public void setUniversityFiscalYear(Integer universityFiscalYear)

Sets the universityFiscalYear attribute.

Parameters:

universityFiscalYear - The universityFiscalYear to set.

getUniversityFiscalPeriodCode

public String getUniversityFiscalPeriodCode()

Gets the universityFiscalPeriodCode attribute.

Returns:

Returns the universityFiscalPeriodCode

setUniversityFiscalPeriodCode

public void setUniversityFiscalPeriodCode(String universityFiscalPeriodCode)

Sets the universityFiscalPeriodCode attribute.

Parameters:

universityFiscalPeriodCode - The universityFiscalPeriodCode to set.

getCustomerPaymentMediumCode

public String getCustomerPaymentMediumCode()

Gets the customerPaymentMediumCode attribute.

Returns:

Returns the customerPaymentMediumCode

setCustomerPaymentMediumCode

public void setCustomerPaymentMediumCode(String customerPaymentMediumCode)

Sets the customerPaymentMediumCode attribute.

Parameters:

customerPaymentMediumCode - The customerPaymentMediumCode to set.

getCashControlTotalAmount

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

Gets the cashControlTotalAmount attribute.

Returns:

Returns the cashControlTotalAmount

setCashControlTotalAmount

public void setCashControlTotalAmount(org.kuali.rice.kns.util.KualiDecimal cashControlTotalAmount)

Sets the cashControlTotalAmount attribute.

Parameters:

cashControlTotalAmount - The cashControlTotalAmount to set.

getUniversityFiscalPeriod

public AccountingPeriod getUniversityFiscalPeriod()

Gets the universityFiscalPeriod attribute.

Returns:

Returns the universityFiscalPeriod

setUniversityFiscalPeriod

public void setUniversityFiscalPeriod(AccountingPeriod universityFiscalPeriod)

Deprecated.

Sets the universityFiscalPeriod attribute.

Parameters:

universityFiscalPeriod - The universityFiscalPeriod to set.

getAccountsReceivableDocumentHeader

public AccountsReceivableDocumentHeader getAccountsReceivableDocumentHeader()

Gets the accountsReceivableDocumentHeader attribute.

Returns:

Returns the accountsReceivableDocumentHeader.

setAccountsReceivableDocumentHeader

public void setAccountsReceivableDocumentHeader(AccountsReceivableDocumentHeader accountsReceivableDocumentHeader)

Sets the accountsReceivableDocumentHeader attribute value.

Parameters:

accountsReceivableDocumentHeader - The accountsReceivableDocumentHeader to set.

getCashControlDetails

public List<CashControlDetail> getCashControlDetails()

Gets the cashControlDetails attribute.

Returns:

Returns the cashControlDetails.

setCashControlDetails

public void setCashControlDetails(List<CashControlDetail> cashControlDetails)

Sets the cashControlDetails attribute value.

Parameters:

cashControlDetails - The cashControlDetails to set.

addCashControlDetail

public void addCashControlDetail(CashControlDetail cashControlDetail)

This method adds a new cash control detail to the list

Parameters:

cashControlDetail -

deleteCashControlDetail

public void deleteCashControlDetail(int index)

This method removes a cash control detail from the list

Parameters:

index -

prepareCashControlDetail

protected void prepareCashControlDetail(CashControlDetail cashControlDetail)

This is a helper method that automatically populates document specfic information into the cash control detail deposit (CashControlDetail) instance.

toStringMapper

protected LinkedHashMap toStringMapper()

Overrides:

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

See Also:

BusinessObjectBase.toStringMapper()

getCustomerPaymentMedium

public PaymentMedium getCustomerPaymentMedium()

Gets the customerPaymentMedium attribute.

Returns:

Returns the customerPaymentMedium

setCustomerPaymentMedium

public void setCustomerPaymentMedium(PaymentMedium customerPaymentMedium)

Sets the customerPaymentMedium attribute value.

Parameters:

customerPaymentMedium - The customerPaymentMedium to set.

getTotalDollarAmount

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

Description copied from interface: AmountTotaling

This method returns the total dollar amount for the document.

Specified by:

getTotalDollarAmount in interface AmountTotaling

Returns:

The total dollar amount as a KualiDecimal object instance.

See Also:

AmountTotaling.getTotalDollarAmount()

getCurrencyFormattedTotalCashControlAmount

public String getCurrencyFormattedTotalCashControlAmount()

This method returns the advance deposit total amount as a currency formatted string.

Returns:

String

getCashControlDetail

public CashControlDetail getCashControlDetail(int index)

Retrieves a specific cash control detail from the list, by array index

Parameters:

index - the index of the cash control details to retrieve the cash control detail from

Returns:

a CashControlDetail

addPendingEntry

public void addPendingEntry(GeneralLedgerPendingEntry entry)

Description copied from class: GeneralLedgerPostingDocumentBase

Adds a GeneralLedgerPendingEntry to this document's list of pending entries

Specified by:

addPendingEntry in interface GeneralLedgerPendingEntrySource

Overrides:

addPendingEntry in class GeneralLedgerPostingDocumentBase

Parameters:

entry - a pending entry to add

See Also:

GeneralLedgerPendingEntrySource.addPendingEntry(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry)

clearAnyGeneralLedgerPendingEntries

public void clearAnyGeneralLedgerPendingEntries()

Description copied from class: GeneralLedgerPostingDocumentBase

This resets this document's list of general ledger pending etnries, though it does not delete those entries (however, the GeneralLedgerPendingEntryService will in most cases when this method is called).

Specified by:

clearAnyGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Overrides:

clearAnyGeneralLedgerPendingEntries in class GeneralLedgerPostingDocumentBase

See Also:

GeneralLedgerPendingEntrySource.clearAnyGeneralLedgerPendingEntries()

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable,
                                                       GeneralLedgerPendingEntry explicitEntry)

See Also:

org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource#customizeExplicitGeneralLedgerPendingEntry(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry)

buildTransactionLedgerEntryDescriptionUsingRefOriginAndRefDocNumber

protected String buildTransactionLedgerEntryDescriptionUsingRefOriginAndRefDocNumber(GeneralLedgerPendingEntrySourceDetail line)

Builds an appropriately formatted string to be used for the transactionLedgerEntryDescription. It is built using information from the AccountingLine. Format is "01-12345: blah blah blah".

Parameters:

line - accounting line

transactionalDocument - submitted accounting document

Returns:

String formatted string to be used for transaction ledger entry description

customizeOffsetGeneralLedgerPendingEntry

public boolean customizeOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine,
                                                        GeneralLedgerPendingEntry explicitEntry,
                                                        GeneralLedgerPendingEntry offsetEntry)

generateDocumentGeneralLedgerPendingEntries

public boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Description copied from interface: GeneralLedgerPendingEntrySource

Creates any GeneralLedgerPostingEntry's that are based on a document, not those based on GeneralLedgerPendingEntrySourceDetail entries

Specified by:

generateDocumentGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Parameters:

sequenceHelper - a sequence helper for the method to create more general ledger pending entries

Returns:

true if the pending entries were able to be successfully created and added to this GeneralLedgerPendingEntrySource; false if an error condition occurred with mean that GLPEs were not correctly generated

See Also:

GeneralLedgerPendingEntrySource.generateDocumentGeneralLedgerPendingEntries(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

getGeneralLedgerPendingEntryAmountForDetail

public org.kuali.rice.kns.util.KualiDecimal getGeneralLedgerPendingEntryAmountForDetail(GeneralLedgerPendingEntrySourceDetail postable)

Description copied from interface: GeneralLedgerPendingEntrySource

A method to determine what the actual amount, based off of a GeneralLedgerPendingEntrySourceDetail, should be for the resultant GeneralLedgerPendingEntry

Specified by:

getGeneralLedgerPendingEntryAmountForDetail in interface GeneralLedgerPendingEntrySource

Parameters:

postable - the detail line from the general ledger pending entry source to find an amount for

Returns:

The amount that will be used to populate the amount on the generated general ledger pending entry for the given source detail

See Also:

org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource#getGeneralLedgerPendingEntryAmountForGeneralLedgerPostable(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail)

getGeneralLedgerPendingEntrySourceDetails

public List<GeneralLedgerPendingEntrySourceDetail> getGeneralLedgerPendingEntrySourceDetails()

Description copied from interface: GeneralLedgerPendingEntrySource

Returns a list of any GeneralLedgerPostables this helper has, to create GeneralLedgerPendingEntries

Specified by:

getGeneralLedgerPendingEntrySourceDetails in interface GeneralLedgerPendingEntrySource

Returns:

a list of GeneralLedgerPostables

See Also:

org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource#getGeneralLedgerPostables()

generateGeneralLedgerPendingEntries

public boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                                   GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

The Cash Control document doesn't generate general ledger pending entries based off of the accounting lines on the document

Specified by:

generateGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Parameters:

glpeSourceDetail - the source detail line to generate general ledger pending entries for

sequenceHelper - the sequence helper which will assign sequence number to generated general ledger pending entries

Returns:

true if general ledger pending entry generation was successful; false if an error condition prevented the successful generation of the pending entries

See Also:

GeneralLedgerPendingEntrySource.generateGeneralLedgerPendingEntries(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

getPostingYear

public Integer getPostingYear()

Specified by:

getPostingYear in interface GeneralLedgerPendingEntrySource

Specified by:

getPostingYear in interface LedgerPostingDocument

Overrides:

getPostingYear in class LedgerPostingDocumentBase

Returns:

posting year for this document

See Also:

GeneralLedgerPendingEntrySource.getPostingYear()

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

Description copied from interface: GeneralLedgerPendingEntrySource

This method determines if the passed in GeneralLedgerPendingEntrySourceDetail is a debit or not.

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Returns:

true if the given GeneralLedgerPendingEntrySourceDetail is a debit, false if it is a credit

See Also:

GeneralLedgerPendingEntrySource.isDebit(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail)

getGeneralLedgerPendingEntries

public List<GeneralLedgerPendingEntry> getGeneralLedgerPendingEntries()

This method gets the glpes

Specified by:

getGeneralLedgerPendingEntries in interface GeneralLedgerPostingDocument

Overrides:

getGeneralLedgerPendingEntries in class GeneralLedgerPostingDocumentBase

Returns:

a list of glpes

See Also:

GeneralLedgerPostingDocument.getGeneralLedgerPendingEntries()

setGeneralLedgerPendingEntries

public void setGeneralLedgerPendingEntries(List<GeneralLedgerPendingEntry> generalLedgerPendingEntries)

This method sets the glpes

Specified by:

setGeneralLedgerPendingEntries in interface GeneralLedgerPostingDocument

Overrides:

setGeneralLedgerPendingEntries in class GeneralLedgerPostingDocumentBase

Parameters:

generalLedgerPendingEntries -

See Also:

GeneralLedgerPostingDocument.setGeneralLedgerPendingEntries(java.util.List)

changeGeneralLedgerPendingEntriesApprovedStatusCode

public void changeGeneralLedgerPendingEntriesApprovedStatusCode()

This method set glpes status to approved

Overrides:

changeGeneralLedgerPendingEntriesApprovedStatusCode in class GeneralLedgerPostingDocumentBase

getGeneralLedgerPendingEntry

public GeneralLedgerPendingEntry getGeneralLedgerPendingEntry(int index)

This method gets an glpe by it's index in the list of glpes

Specified by:

getGeneralLedgerPendingEntry in interface GeneralLedgerPostingDocument

Overrides:

getGeneralLedgerPendingEntry in class GeneralLedgerPostingDocumentBase

Parameters:

index - the glpe index

Returns:

the glpe

See Also:

GeneralLedgerPostingDocument.getGeneralLedgerPendingEntry(int)

getLockboxNumber

public String getLockboxNumber()

populateDocumentForRouting

public void populateDocumentForRouting()

Specified by:

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

Overrides:

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

See Also:

DocumentBase.populateDocumentForRouting()

declaimElectronicPaymentClaims

public void declaimElectronicPaymentClaims()

Description copied from interface: ElectronicPaymentClaiming

A method which is called when a document is disapproved or canceled, which removes the claim the document had on any ElectronicPaymentClaim records.

Specified by:

declaimElectronicPaymentClaims in interface ElectronicPaymentClaiming

See Also:

ElectronicPaymentClaiming.declaimElectronicPaymentClaims()

getElectronicPaymentClaims

public List<ElectronicPaymentClaim> getElectronicPaymentClaims()

This method gets electronicPaymentClaims

Returns:

electronicPaymentClaims

setElectronicPaymentClaims

public void setElectronicPaymentClaims(List<ElectronicPaymentClaim> electronicPaymentClaims)

Deprecated.

This method sets electronicPaymentClaims

Parameters:

electronicPaymentClaims -

getFinancialDocumentTypeCode

public String getFinancialDocumentTypeCode()

Description copied from class: LedgerPostingDocumentBase

Returns the financial document type code for the given document, using the DataDictionaryService

Specified by:

getFinancialDocumentTypeCode in interface GeneralLedgerPendingEntrySource

Overrides:

getFinancialDocumentTypeCode in class LedgerPostingDocumentBase

Returns:

the financial document type code for the given document

getReferenceFinancialDocument

public org.kuali.rice.kns.document.Document getReferenceFinancialDocument()

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.

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Answers true when document payment medium is WIRE transfer

Specified by:

answerSplitNodeQuestion in interface FinancialSystemTransactionalDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(java.lang.String)

getChartOfAccountsCode

public String getChartOfAccountsCode()

This is a helper method added to support workflow attribute configuration. This method helps to avoid attribute name mismatch between ProcessingChartOfAccountCode and chartOfAccountsCode

Returns:

ProcessingChartOfAccountCode

getOrganizationCode

public String getOrganizationCode()

This is a helper method added to support workflow attribute configuration. This method helps to avoid attribute name mismatch between ProcessingOrganizationCode and organizationCode

Returns:

ProcessingOrganizationCode

getBank

public Bank getBank()

setBank

public void setBank(Bank bank)

recalculateTotals

public void recalculateTotals()

prepareForSave

public void prepareForSave()

Description copied from class: FinancialSystemTransactionalDocumentBase

If the document has a total amount, call method on document to get the total and set in doc header.

Specified by:

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

Overrides:

prepareForSave in class FinancialSystemTransactionalDocumentBase

See Also:

Document.prepareForSave()

deleteCashControlDetailsFromDB

protected void deleteCashControlDetailsFromDB()

getGeneralLedgerEntriesPostedCount

public Integer getGeneralLedgerEntriesPostedCount()

This is a method to check the count of gl entries according to the input fields and values

Returns:

totalGLRecordsCreated returns the count of the gl entries