org.kuali.kfs.fp.document
Class YearEndBudgetAdjustmentDocument

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.BudgetAdjustmentDocument
                                      org.kuali.kfs.fp.document.YearEndBudgetAdjustmentDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, YearEndDocument, 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

public class YearEndBudgetAdjustmentDocument
extends BudgetAdjustmentDocument
implements YearEndDocument

Year End version of the BudgetAdjustmentDocument

See Also:

Serialized Form

Field Summary

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

LOG, nextPositionSourceLineNumber, nextPositionTargetLineNumber, REQUIRES_FULL_APPROVAL_SPLIT_NODE_NAME

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

YearEndBudgetAdjustmentDocument()
Constructs a YearEndBudgetAdjustmentDocument.

Method Summary

void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) This method calls the super class's overridden method to perform the general customization actions, then calls the YearEndDocumentUtil matching method to perform year end specific customization activities.
boolean	customizeOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry) Overridden to populate object code from last year's offset definition
Class<? extends AccountingDocument>	getDocumentClassForAccountingLineValueAllowedValidation() This method returns the Class to use for AccountingLingValuesAllowedValidation.
protected String	getTransferDocumentType() This method retrieves the year end transfer of funds document type code, which is defined as a constant in TransferOfFundsDocumentRuleConstants.
void	initiateDocument() set posting year to previous fiscal year

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

answerSplitNodeQuestion, buildIncomeStreamBalanceMapForDocumentBalance, buildIncomeStreamBalanceMapForTransferOfFundsGeneration, createMonthlyBudgetGLPE, generateDocumentGeneralLedgerPendingEntries, generateGeneralLedgerPendingEntries, getAllowsCopy, getCurrencyFormattedSourceBaseBudgetTotal, getCurrencyFormattedSourceCurrentBudgetTotal, getCurrencyFormattedTargetBaseBudgetTotal, getCurrencyFormattedTargetCurrentBudgetTotal, getGeneralLedgerPendingEntryService, getIncomeStreamAmount, getNextPositionSourceLineNumber, getNextPositionTargetLineNumber, getPendingLedgerEntriesForSufficientFundsChecking, getSourceAccountingLinesSectionTitle, getSourceBaseBudgetExpenseTotal, getSourceBaseBudgetIncomeTotal, getSourceBaseBudgetTotal, getSourceCurrentBudgetExpenseTotal, getSourceCurrentBudgetIncomeTotal, getSourceCurrentBudgetTotal, getTargetAccountingLinesSectionTitle, getTargetBaseBudgetExpenseTotal, getTargetBaseBudgetIncomeTotal, getTargetBaseBudgetTotal, getTargetCurrentBudgetExpenseTotal, getTargetCurrentBudgetIncomeTotal, getTargetCurrentBudgetTotal, getTotalDollarAmount, isDebit, populateDocumentForRouting, requiresFullApproval, setNextPositionSourceLineNumber, setNextPositionTargetLineNumber, toErrorCorrection, toStringMapper

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

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

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, doRouteStatusChange, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, 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

getDocumentHeader, prepareForSave, processAfterRetrieve, setDocumentHeader

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

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, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, 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, 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, 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

getDocumentHeader

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

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, doRouteStatusChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, postProcessSave, 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

Constructor Detail

YearEndBudgetAdjustmentDocument

public YearEndBudgetAdjustmentDocument()

Constructs a YearEndBudgetAdjustmentDocument.

Method Detail

initiateDocument

public void initiateDocument()

set posting year to previous fiscal year

Overrides:

initiateDocument in class BudgetAdjustmentDocument

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable,
                                                       GeneralLedgerPendingEntry explicitEntry)

This method calls the super class's overridden method to perform the general customization actions, then calls the YearEndDocumentUtil matching method to perform year end specific customization activities.

Overrides:

customizeExplicitGeneralLedgerPendingEntry in class AccountingDocumentBase

Parameters:

accountingDocument - The accounting document containing the general ledger pending entries being customized.

accountingLine - The accounting line the explicit general ledger pending entry was generated from.

explicitEntry - The explicit general ledger pending entry to be customized.

See Also:

org.kuali.kfs.fp.document.validation.impl.BudgetAdjustmentDocumentRule#customizeExplicitGeneralLedgerPendingEntry(org.kuali.rice.kns.document.AccountingDocument, org.kuali.rice.kns.bo.AccountingLine, org.kuali.module.gl.bo.GeneralLedgerPendingEntry), YearEndDocumentUtil#customizeExplicitGeneralLedgerPendingEntry(TransactionalDocument, AccountingLine, GeneralLedgerPendingEntry)

customizeOffsetGeneralLedgerPendingEntry

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

Overridden to populate object code from last year's offset definition

Overrides:

customizeOffsetGeneralLedgerPendingEntry in class AccountingDocumentBase

See Also:

AccountingDocumentBase.customizeOffsetGeneralLedgerPendingEntry(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry)

getTransferDocumentType

protected String getTransferDocumentType()

This method retrieves the year end transfer of funds document type code, which is defined as a constant in TransferOfFundsDocumentRuleConstants.

Overrides:

getTransferDocumentType in class BudgetAdjustmentDocument

Returns:

The value defined in the constants class for year end transfer of funds document type code.

See Also:

org.kuali.kfs.fp.document.validation.impl.BudgetAdjustmentDocumentRule#getTransferDocumentType(), TransferOfFundsDocumentRuleConstants.YEAR_END_TRANSFER_OF_FUNDS_DOC_TYPE_CODE

getDocumentClassForAccountingLineValueAllowedValidation

public Class<? extends AccountingDocument> getDocumentClassForAccountingLineValueAllowedValidation()

Description copied from interface: AccountingDocument

This method returns the Class to use for AccountingLingValuesAllowedValidation.

Specified by:

getDocumentClassForAccountingLineValueAllowedValidation in interface AccountingDocument

Overrides:

getDocumentClassForAccountingLineValueAllowedValidation in class AccountingDocumentBase