org.kuali.ole.fp.document

Class DistributionOfIncomeExpenseDocument

java.lang.Object

org.kuali.rice.krad.bo.DataObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.OLEFinancialSystemTransactionalDocumentBase

org.kuali.ole.sys.document.OLELedgerPostingDocumentBase

org.kuali.ole.sys.document.OLEGeneralLedgerPostingDocumentBase

org.kuali.ole.sys.document.OLEAccountingDocumentBase

org.kuali.ole.fp.document.OLECapitalAssetInformationDocumentBase

org.kuali.ole.fp.document.OLECapitalAccountingLinesDocumentBase

org.kuali.ole.fp.document.DistributionOfIncomeExpenseDocument

All Implemented Interfaces:

Serializable, Cloneable, org.eclipse.persistence.descriptors.changetracking.ChangeTracker, org.eclipse.persistence.internal.descriptors.PersistenceEntity, org.eclipse.persistence.internal.descriptors.PersistenceObject, org.eclipse.persistence.internal.weaving.PersistenceWeaved, org.eclipse.persistence.internal.weaving.PersistenceWeavedChangeTracking, org.eclipse.persistence.internal.weaving.PersistenceWeavedFetchGroups, org.eclipse.persistence.internal.weaving.PersistenceWeavedRest, org.eclipse.persistence.queries.FetchGroupTracker, OLECapitalAssetEditable, AmountTotaling, Correctable, ElectronicPaymentClaiming, OLEAccountingDocument, OLEFinancialSystemDocument, OLEFinancialSystemTransactionalDocument, OLEGeneralLedgerPendingEntrySource, OLEGeneralLedgerPostingDocument, OLELedgerPostingDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, 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:

OleDistributionOfIncomeAndExpenseDocument

public class DistributionOfIncomeExpenseDocument
extends OLECapitalAccountingLinesDocumentBase
implements org.kuali.rice.krad.document.Copyable, Correctable, AmountTotaling, ElectronicPaymentClaiming

The Distribution of Income and Expense (DI) document is used to distribute income or expense, or assets and liabilities. Amounts being distributed are usually the result of an accumulation of transactions that need to be divided up between various accounts.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CapitalAssetManagementModuleService	capitalAssetManagementModuleService
protected List<ElectronicPaymentClaim>	electronicPaymentClaims
protected static org.apache.log4j.Logger	LOG

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

capitalAccountingLines

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

capitalAssetInformation, nextCapitalAssetLineNumber

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

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

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

generalLedgerPendingEntries

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

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

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

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

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

adHocRoutePersons, adHocRouteWorkgroups, documentHeader, documentNumber, notes, pessimisticLocks

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

extension, newCollectionRecord

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

_persistence_cacheKey, _persistence_fetchGroup, _persistence_href, _persistence_listener, _persistence_primaryKey, _persistence_relationshipInfo, _persistence_session, _persistence_shouldRefreshFetchGroup, objectId, versionNumber

Constructor Summary

Constructors

Constructor and Description
DistributionOfIncomeExpenseDocument() Constructs a DistributionOfIncomeAndExpenseDocument.java.

Method Summary

Methods

Modifier and Type	Method and Description
void	declaimElectronicPaymentClaims() A method which is called when a document is disapproved or canceled, which removes the claim the document had on any ElectronicPaymentClaim records.
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.
List<ElectronicPaymentClaim>	getElectronicPaymentClaims() Gets the electronicPaymentClaims attribute.
String	getSourceAccountingLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source accounting line section.
String	getTargetAccountingLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source accounting line section.
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.DocumentEvent event)
void	setElectronicPaymentClaims(List<ElectronicPaymentClaim> electronicPaymentClaims) Deprecated.

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

getCapitalAccountingLines, setCapitalAccountingLines

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

buildListOfDeletionAwareLists, getCapitalAssetInformation, getNextCapitalAssetLineNumber, isDebit, setCapitalAssetInformation, setNextCapitalAssetLineNumber

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

addSourceAccountingLine, addTargetAccountingLine, buildAccountingLineMap, copyAccountingLines, customizeExplicitGeneralLedgerPendingEntry, customizeOffsetGeneralLedgerPendingEntry, generateDocumentGeneralLedgerPendingEntries, generateEvents, generateGeneralLedgerPendingEntries, generateSaveEvents, getAccountingLineParser, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getOLEDataDictionaryEntry, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesForComparison, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, 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.OLEGeneralLedgerPostingDocumentBase

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

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

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

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

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

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

_persistence_get, _persistence_new, _persistence_post_clone, _persistence_set, getAllowsCopy, isSessionDocument

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

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

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

getExtension, getLegacyDataAdapter, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord

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

_persistence_checkFetched, _persistence_checkFetchedForSet, _persistence_get_objectId, _persistence_get_versionNumber, _persistence_getCacheKey, _persistence_getFetchGroup, _persistence_getHref, _persistence_getId, _persistence_getPropertyChangeListener, _persistence_getRelationships, _persistence_getSession, _persistence_isAttributeFetched, _persistence_propertyChange, _persistence_resetFetchGroup, _persistence_set_objectId, _persistence_set_versionNumber, _persistence_setCacheKey, _persistence_setFetchGroup, _persistence_setHref, _persistence_setId, _persistence_setPropertyChangeListener, _persistence_setRelationships, _persistence_setSession, _persistence_setShouldRefreshFetchGroup, _persistence_shallow_clone, _persistence_shouldRefreshFetchGroup, generateAndSetObjectIdIfNeeded, getExtensionObject, getObjectId, getVersionNumber, preUpdate, setExtensionObject, setObjectId, setVersionNumber, 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.sys.document.OLEGeneralLedgerPostingDocument

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

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

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

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

answerSplitNodeQuestion, getFinancialSystemDocumentHeader

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

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

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

getObjectId

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

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getPostingYear

Methods inherited from interface org.eclipse.persistence.internal.descriptors.PersistenceObject

_persistence_shallow_clone

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

electronicPaymentClaims

protected List<ElectronicPaymentClaim> electronicPaymentClaims

capitalAssetManagementModuleService

protected transient CapitalAssetManagementModuleService capitalAssetManagementModuleService

Constructor Detail

DistributionOfIncomeExpenseDocument

public DistributionOfIncomeExpenseDocument()

Constructs a DistributionOfIncomeAndExpenseDocument.java.

Method Detail

getSourceAccountingLinesSectionTitle

public String getSourceAccountingLinesSectionTitle()

Description copied from interface: OLEAccountingDocument

This method is used to return the title that a transactional document should give to it's source accounting line section.

Specified by:

getSourceAccountingLinesSectionTitle in interface OLEAccountingDocument

Overrides:

getSourceAccountingLinesSectionTitle in class OLEAccountingDocumentBase

Returns:

The source accounting line section's title.

See Also:

AccountingDocument.getSourceAccountingLinesSectionTitle()

getTargetAccountingLinesSectionTitle

public String getTargetAccountingLinesSectionTitle()

Description copied from interface: OLEAccountingDocument

This method is used to return the title that a transactional document should give to it's source accounting line section.

Specified by:

getTargetAccountingLinesSectionTitle in interface OLEAccountingDocument

Overrides:

getTargetAccountingLinesSectionTitle in class OLEAccountingDocumentBase

Returns:

The target accounting line section's title.

See Also:

AccountingDocument.getTargetAccountingLinesSectionTitle()

declaimElectronicPaymentClaims

public void declaimElectronicPaymentClaims()

Description copied from interface: ElectronicPaymentClaiming

A method which is called when a document is disapproved or canceled, which removes the claim the document had on any ElectronicPaymentClaim records.

Specified by:

declaimElectronicPaymentClaims in interface ElectronicPaymentClaiming

See Also:

ElectronicPaymentClaiming.declaimElectronicPaymentClaims()

getElectronicPaymentClaims

public List<ElectronicPaymentClaim> getElectronicPaymentClaims()

Gets the electronicPaymentClaims attribute.

Returns:

Returns the electronicPaymentClaims.

setElectronicPaymentClaims

public void setElectronicPaymentClaims(List<ElectronicPaymentClaim> electronicPaymentClaims)

Deprecated.

Sets the electronicPaymentClaims attribute value.

Parameters:

electronicPaymentClaims - The electronicPaymentClaims to set.

doRouteStatusChange

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

Description copied from class: OLEGeneralLedgerPostingDocumentBase

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 OLECapitalAssetInformationDocumentBase

See Also:

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

postProcessSave

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

Specified by:

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

Overrides:

postProcessSave in class DocumentBase

See Also:

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