org.kuali.kfs.module.ld.document
Class LaborExpenseTransferDocumentBase

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.module.ld.document.LaborLedgerPostingDocumentBase
                                      org.kuali.kfs.module.ld.document.LaborExpenseTransferDocumentBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, LaborLedgerPostingDocumentForSearching, LaborExpenseTransferDocument, LaborLedgerPostingDocument, AccountingDocument, AmountTotaling, Correctable, 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

Direct Known Subclasses:

BenefitExpenseTransferDocument, SalaryExpenseTransferDocument

public abstract class LaborExpenseTransferDocumentBase
extends LaborLedgerPostingDocumentBase
implements AmountTotaling, org.kuali.rice.kns.document.Copyable, Correctable, LaborExpenseTransferDocument

Labor Base class for Expense Transfer Documents

See Also:

Serialized Form

Field Summary

protected String	emplid
protected static org.apache.commons.logging.Log	LOG
protected org.kuali.rice.kim.bo.Person	user

Fields inherited from class org.kuali.kfs.module.ld.document.LaborLedgerPostingDocumentBase

LABOR_LEDGER_GENERAL_LEDGER_POSTING_HELPER_BEAN_ID, laborLedgerPendingEntries

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

LaborExpenseTransferDocumentBase()
Constructor

Method Summary

String	getEmplid() Gets the emplid
Class	getSourceAccountingLineClass() Returns the default Source accounting line class.
String	getSourceAccountingLinesSectionTitle() Overrides the base implementation to return "From".
Class	getTargetAccountingLineClass() Returns the default Target accounting line class.
String	getTargetAccountingLinesSectionTitle() Overrides the base implementation to return "To".
Map<String,org.kuali.rice.kns.util.KualiDecimal>	getUnbalancedObjectCodes() Determine whether target accouting lines have the same amounts as source accounting lines for each object code
org.kuali.rice.kim.bo.Person	getUser() Gets the user attribute.
void	setEmplid(String emplid) Sets the emplid
void	setUser(org.kuali.rice.kim.bo.Person user) Sets the user attribute value.
protected Map<String,org.kuali.rice.kns.util.KualiDecimal>	summerizeByObjectCode(List accountingLines) summerize the amounts of accounting lines by object codes

Methods inherited from class org.kuali.kfs.module.ld.document.LaborLedgerPostingDocumentBase

changeLedgerPendingEntriesApprovedStatusCode, doRouteStatusChange, generateGeneralLedgerPendingEntries, getLaborLedgerPendingEntries, getLaborLedgerPendingEntry, isDebit, prepareForSave, removeLedgerPendingEntries, setLaborLedgerPendingEntries

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

addSourceAccountingLine, addTargetAccountingLine, buildAccountingLineMap, buildListOfDeletionAwareLists, copyAccountingLines, customizeExplicitGeneralLedgerPendingEntry, customizeOffsetGeneralLedgerPendingEntry, generateDocumentGeneralLedgerPendingEntries, generateEvents, generateSaveEvents, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesForComparison, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesForComparison, getTargetTotal, getTotalDollarAmount, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, toErrorCorrection, updatePostingYearForAccountingLines

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, 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, postProcessSave, 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.kfs.sys.document.AmountTotaling

getTotalDollarAmount

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

toCopy

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

toErrorCorrection

Methods inherited from interface org.kuali.kfs.module.ld.document.LaborLedgerPostingDocument

generateLaborLedgerBenefitClearingPendingEntries, generateLaborLedgerPendingEntries, getLaborLedgerPendingEntries, getLaborLedgerPendingEntriesForSearching, getLaborLedgerPendingEntry, setLaborLedgerPendingEntries

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

addSourceAccountingLine, addTargetAccountingLine, getAccountingLineParser, getDocumentClassForAccountingLineValueAllowedValidation, getNextSourceLineNumber, getNextTargetLineNumber, getSourceAccountingLine, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineEntryName, getTargetAccountingLines, 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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

emplid

protected String emplid

user

protected org.kuali.rice.kim.bo.Person user

Constructor Detail

LaborExpenseTransferDocumentBase

public LaborExpenseTransferDocumentBase()

Constructor

Method Detail

getUnbalancedObjectCodes

public Map<String,org.kuali.rice.kns.util.KualiDecimal> getUnbalancedObjectCodes()

Determine whether target accouting lines have the same amounts as source accounting lines for each object code

Returns:

true if target accouting lines have the same amounts as source accounting lines for each object code; otherwise, false

summerizeByObjectCode

protected Map<String,org.kuali.rice.kns.util.KualiDecimal> summerizeByObjectCode(List accountingLines)

summerize the amounts of accounting lines by object codes

Parameters:

accountingLines - the given accounting line list

Returns:

the summerized amounts by object codes

getEmplid

public String getEmplid()

Gets the emplid

Specified by:

getEmplid in interface LaborExpenseTransferDocument

Returns:

Returns the emplid.

See Also:

LaborExpenseTransferDocument.getEmplid()

setEmplid

public void setEmplid(String emplid)

Sets the emplid

Specified by:

setEmplid in interface LaborExpenseTransferDocument

Parameters:

emplid -

See Also:

LaborExpenseTransferDocument.setEmplid(String)

getUser

public org.kuali.rice.kim.bo.Person getUser()

Gets the user attribute.

Returns:

Returns the user.

setUser

public void setUser(org.kuali.rice.kim.bo.Person user)

Sets the user attribute value.

Parameters:

user - The user to set.

getSourceAccountingLinesSectionTitle

public String getSourceAccountingLinesSectionTitle()

Overrides the base implementation to return "From".

Specified by:

getSourceAccountingLinesSectionTitle in interface AccountingDocument

Overrides:

getSourceAccountingLinesSectionTitle in class AccountingDocumentBase

Returns:

The source accounting line section's title.

See Also:

org.kuali.rice.kns.document.AccountingDocument#getSourceAccountingLinesSectionTitle()

getTargetAccountingLinesSectionTitle

public String getTargetAccountingLinesSectionTitle()

Overrides the base implementation to return "To".

Specified by:

getTargetAccountingLinesSectionTitle in interface AccountingDocument

Overrides:

getTargetAccountingLinesSectionTitle in class AccountingDocumentBase

Returns:

The target accounting line section's title.

See Also:

org.kuali.rice.kns.document.AccountingDocument#getTargetAccountingLinesSectionTitle()

getSourceAccountingLineClass

public Class getSourceAccountingLineClass()

Description copied from class: AccountingDocumentBase

Returns the default Source accounting line class.

Specified by:

getSourceAccountingLineClass in interface AccountingDocument

Overrides:

getSourceAccountingLineClass in class AccountingDocumentBase

Returns:

Returns the ExpenseTransferSourceAccountingLine

See Also:

AccountingDocumentBase.getSourceAccountingLineClass()

getTargetAccountingLineClass

public Class getTargetAccountingLineClass()

Description copied from class: AccountingDocumentBase

Returns the default Target accounting line class.

Specified by:

getTargetAccountingLineClass in interface AccountingDocument

Overrides:

getTargetAccountingLineClass in class AccountingDocumentBase

Returns:

Returns the ExpenseTransferTargetAccountingLine

See Also:

AccountingDocumentBase.getTargetAccountingLineClass()