org.kuali.kfs.module.ld.document
Interface LaborLedgerPostingDocument

All Superinterfaces:

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

All Known Subinterfaces:

LaborExpenseTransferDocument

All Known Implementing Classes:

BenefitExpenseTransferDocument, LaborExpenseTransferDocumentBase, LaborJournalVoucherDocument, LaborLedgerPostingDocumentBase, LaborYearEndBenefitTransferDocument, SalaryExpenseTransferDocument, YearEndBenefitExpenseTransferDocument, YearEndSalaryExpenseTransferDocument

public interface LaborLedgerPostingDocument
extends AccountingDocument, LaborLedgerPostingDocumentForSearching

Labor Document Defines methods that must be implements for a labor ledger posting document.

Method Summary

boolean	generateLaborLedgerBenefitClearingPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) creating a list of benefit clearing Pending entries
boolean	generateLaborLedgerPendingEntries(AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) creating a list of Expense Pending entries and Benefit pending Entries
List<LaborLedgerPendingEntry>	getLaborLedgerPendingEntries() Retrieves the list of Labor Ledger Pending Entries for the document.
List	getLaborLedgerPendingEntriesForSearching() Retrieves the list of Labor Ledger Pending Entries for the document.
LaborLedgerPendingEntry	getLaborLedgerPendingEntry(int index) Get the pending entry with the given index in the list of labor ledger pending entries
void	setLaborLedgerPendingEntries(List<LaborLedgerPendingEntry> laborLedgerPendingEntries) Sets the list of labor ledger pending entries for the document.

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

addSourceAccountingLine, addTargetAccountingLine, getAccountingLineParser, getDocumentClassForAccountingLineValueAllowedValidation, getNextSourceLineNumber, getNextTargetLineNumber, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesSectionTitle, getTargetTotal, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines

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, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, 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

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

addPendingEntry, clearAnyGeneralLedgerPendingEntries, generateDocumentGeneralLedgerPendingEntries, generateGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getPostingYear, isDebit

Method Detail

getLaborLedgerPendingEntriesForSearching

List getLaborLedgerPendingEntriesForSearching()

Retrieves the list of Labor Ledger Pending Entries for the document.

Specified by:

getLaborLedgerPendingEntriesForSearching in interface LaborLedgerPostingDocumentForSearching

Returns:

A list of labor ledger pending entries.

getLaborLedgerPendingEntries

List<LaborLedgerPendingEntry> getLaborLedgerPendingEntries()

Retrieves the list of Labor Ledger Pending Entries for the document.

Returns:

A list of labor ledger pending entries.

setLaborLedgerPendingEntries

void setLaborLedgerPendingEntries(List<LaborLedgerPendingEntry> laborLedgerPendingEntries)

Sets the list of labor ledger pending entries for the document.

Parameters:

laborLedgerPendingEntries - the given labor ledger pending entries

getLaborLedgerPendingEntry

LaborLedgerPendingEntry getLaborLedgerPendingEntry(int index)

Get the pending entry with the given index in the list of labor ledger pending entries

Parameters:

index - the given index

Returns:

the pending entry with the given index in the list of labor ledger pending entries

generateLaborLedgerPendingEntries

boolean generateLaborLedgerPendingEntries(AccountingLine accountingLine,
                                          GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

creating a list of Expense Pending entries and Benefit pending Entries

Parameters:

accountingLine - the accounting line being used to generate pending entries

sequenceHelper - the sequence number generator

Returns:

true after creating a list of Expense Pending entries and Benefit pending Entries

generateLaborLedgerBenefitClearingPendingEntries

boolean generateLaborLedgerBenefitClearingPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

creating a list of benefit clearing Pending entries

Parameters:

sequenceHelper - the sequence number generator

Returns:

true after creating a list of benefit clearing Pending entries