org.kuali.kfs.module.cam.document.gl
Class CamsGeneralLedgerPendingEntrySourceBase

java.lang.Object
  org.kuali.kfs.module.cam.document.gl.CamsGeneralLedgerPendingEntrySourceBase

All Implemented Interfaces:

GeneralLedgerPendingEntrySource

Direct Known Subclasses:

AssetGlobalGeneralLedgerPendingEntrySource, AssetRetirementGeneralLedgerPendingEntrySource

public abstract class CamsGeneralLedgerPendingEntrySourceBase
extends Object
implements GeneralLedgerPendingEntrySource

Constructor Summary

CamsGeneralLedgerPendingEntrySourceBase(FinancialSystemDocumentHeader documentHeader)

Method Summary

void	addPendingEntry(GeneralLedgerPendingEntry entry) Adds an UNSAVED general ledger pending entry to the GeneralLedgerPendingEntrySource, which the GLPESource can do with as it pleases
void	clearAnyGeneralLedgerPendingEntries() Requests that the posting helper removes any general ledger pending entries it might be holding, so that new ones can be generated
void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry)
void	doRouteStatusChange(List<GeneralLedgerPendingEntry> glPendingEntries)
boolean	generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Creates any GeneralLedgerPostingEntry's that are based on a document, not those based on GeneralLedgerPendingEntrySourceDetail entries
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Generates any number of general ledger pending entries from a given general ledger pending entry source detail and adds them to this general ledger pending entry source
FinancialSystemDocumentHeader	getDocumentHeader() Returns a document header associated with this general ledger posting helper
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
List<GeneralLedgerPendingEntry>	getPendingEntries()
List<GeneralLedgerPendingEntrySourceDetail>	getPostables()
Integer	getPostingYear()
void	setDocumentHeader(FinancialSystemDocumentHeader documentHeader)
void	setPendingEntries(List<GeneralLedgerPendingEntry> pendingEntries)
void	setPostables(List<GeneralLedgerPendingEntrySourceDetail> postables)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getFinancialDocumentTypeCode, isDebit

Constructor Detail

CamsGeneralLedgerPendingEntrySourceBase

public CamsGeneralLedgerPendingEntrySourceBase(FinancialSystemDocumentHeader documentHeader)

Method Detail

addPendingEntry

public void addPendingEntry(GeneralLedgerPendingEntry entry)

Description copied from interface: GeneralLedgerPendingEntrySource

Adds an UNSAVED general ledger pending entry to the GeneralLedgerPendingEntrySource, which the GLPESource can do with as it pleases

Specified by:

addPendingEntry in interface GeneralLedgerPendingEntrySource

Parameters:

entry - the completed entry to give back to the helper to handle

clearAnyGeneralLedgerPendingEntries

public void clearAnyGeneralLedgerPendingEntries()

Description copied from interface: GeneralLedgerPendingEntrySource

Requests that the posting helper removes any general ledger pending entries it might be holding, so that new ones can be generated

Specified by:

clearAnyGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable,
                                                       GeneralLedgerPendingEntry explicitEntry)

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

getDocumentHeader

public FinancialSystemDocumentHeader getDocumentHeader()

Description copied from interface: GeneralLedgerPendingEntrySource

Returns a document header associated with this general ledger posting helper

Specified by:

getDocumentHeader in interface GeneralLedgerPendingEntrySource

Returns:

a document header, having information which should be put into the generated GeneralLedgerPendingEntry records

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

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

getPostingYear

public Integer getPostingYear()

Specified by:

getPostingYear in interface GeneralLedgerPendingEntrySource

Returns:

the fiscal year when this "helper" was posted

getPendingEntries

public List<GeneralLedgerPendingEntry> getPendingEntries()

setPendingEntries

public void setPendingEntries(List<GeneralLedgerPendingEntry> pendingEntries)

getPostables

public List<GeneralLedgerPendingEntrySourceDetail> getPostables()

setPostables

public void setPostables(List<GeneralLedgerPendingEntrySourceDetail> postables)

setDocumentHeader

public void setDocumentHeader(FinancialSystemDocumentHeader documentHeader)

doRouteStatusChange

public void doRouteStatusChange(List<GeneralLedgerPendingEntry> glPendingEntries)

generateGeneralLedgerPendingEntries

public boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail postable,
                                                   GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Description copied from interface: GeneralLedgerPendingEntrySource

Generates any number of general ledger pending entries from a given general ledger pending entry source detail and adds them to this general ledger pending entry source

Specified by:

generateGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Parameters:

postable - 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