org.kuali.ole.fp.document

Class GeneralErrorCorrectionDocument

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

org.kuali.ole.sys.document.LedgerPostingDocumentBase

org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

org.kuali.ole.sys.document.AccountingDocumentBase

org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

org.kuali.ole.fp.document.GeneralErrorCorrectionDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, CapitalAssetEditable, AccountingDocument, AmountTotaling, Correctable, FinancialSystemDocument, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

OleGeneralErrorCorrectionDocument, YearEndGeneralErrorCorrectionDocument

public class GeneralErrorCorrectionDocument
extends CapitalAccountingLinesDocumentBase
implements org.kuali.rice.krad.document.Copyable, Correctable, AmountTotaling, CapitalAssetEditable

This is the business object that represents the GeneralErrorCorrectionDocument in Kuali. This is a transactional document that will eventually post transactions to the G/L. It integrates with workflow and also contains two groupings of accounting lines: from and to. From lines are the source lines, to lines are the target lines.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CapitalAssetManagementModuleService	capitalAssetManagementModuleService
protected static org.apache.log4j.Logger	LOG

Fields inherited from class org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

capitalAccountingLines

Fields inherited from class org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

capitalAssetInformation, nextCapitalAssetLineNumber

Fields inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

dataDictionaryEntry, nextSourceLineNumber, nextTargetLineNumber, sourceAccountingLineClass, sourceAccountingLines, targetAccountingLineClass, targetAccountingLines

Fields inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

generalLedgerPendingEntries

Fields inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

accountingPeriod, accountingPeriodService, checkPostingYearForCopy, dataDictionaryService, dateTimeService, postingPeriodCode, postingYear

Fields inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

documentHeader, documentNumber

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
GeneralErrorCorrectionDocument() Initializes the array lists and some basic info.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildTransactionLedgerEntryDescriptionUsingRefOriginAndRefDocNumber(GeneralLedgerPendingEntrySourceDetail line) Builds an appropriately formatted string to be used for the transactionLedgerEntryDescription.
void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) Customizes a GLPE by setting financial document number, financial system origination code and document type code to null
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) Override to call super and then iterate over all GLPEs and update the approved code appropriately.
CapitalAssetManagementModuleService	getCapitalAssetManagementModuleService()
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".
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Methods inherited from class org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

getCapitalAccountingLines, setCapitalAccountingLines

Methods inherited from class org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

buildListOfDeletionAwareLists, getCapitalAssetInformation, getNextCapitalAssetLineNumber, isDebit, setCapitalAssetInformation, setNextCapitalAssetLineNumber

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

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

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, removeGeneralLedgerPendingEntries, setGeneralLedgerPendingEntries

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

createInitialAccountingPeriod, getAccountingPeriod, getAccountingPeriodCompositeString, getAccountingPeriodService, getDataDictionaryService, getDateTimeService, getFinancialDocumentTypeCode, getPostingPeriodCode, getPostingYear, retrieveCurrentAccountingPeriod, setAccountingPeriod, setAccountingPeriodCompositeString, setPostingPeriodCode, setPostingYear

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

answerSplitNodeQuestion, doRouteLevelChange, getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, prepareForSave, processAfterRetrieve, setApplicationDocumentStatus, setDocumentHeader, updateAndSaveAppDocStatus

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

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

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

toCopy

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

toErrorCorrection

Methods inherited from interface org.kuali.ole.sys.document.AmountTotaling

getTotalDollarAmount

Methods inherited from interface org.kuali.ole.fp.document.CapitalAssetEditable

getCapitalAssetInformation, setCapitalAssetInformation

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

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

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

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.ole.sys.document.FinancialSystemDocument

answerSplitNodeQuestion, getFinancialSystemDocumentHeader

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

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

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

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getPostingYear

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

capitalAssetManagementModuleService

protected transient CapitalAssetManagementModuleService capitalAssetManagementModuleService

Constructor Detail

GeneralErrorCorrectionDocument

public GeneralErrorCorrectionDocument()

Initializes the array lists and some basic info.

Method Detail

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:

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:

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

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

See Also:

AccountingDocumentBase.getTargetAccountingLineClass()

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable,
                                              GeneralLedgerPendingEntry explicitEntry)

Customizes a GLPE by setting financial document number, financial system origination code and document type code to null

Overrides:

customizeExplicitGeneralLedgerPendingEntry in class AccountingDocumentBase

Parameters:

transactionalDocument - submitted accounting document

accountingLine - accounting line in document

explicitEntry - general ledger pending entry

See Also:

FinancialDocumentRuleBase#customizeExplicitGeneralLedgerPendingEntry(FinancialDocument, AccountingLine, 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

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

Description copied from class: GeneralLedgerPostingDocumentBase

Override to call super and then iterate over all GLPEs and update the approved code appropriately.

Specified by:

doRouteStatusChange in interface org.kuali.rice.krad.document.Document

Overrides:

doRouteStatusChange in class CapitalAssetInformationDocumentBase

See Also:

org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase#doRouteStatusChange()

postProcessSave

public void postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Specified by:

postProcessSave in interface org.kuali.rice.krad.document.Document

Overrides:

postProcessSave in class org.kuali.rice.krad.document.DocumentBase

See Also:

org.kuali.rice.krad.document.DocumentBase#postProcessSave(org.kuali.rice.krad.rule.event.KualiDocumentEvent)

getCapitalAssetManagementModuleService

public CapitalAssetManagementModuleService getCapitalAssetManagementModuleService()

Returns:

CapitalAssetManagementModuleService