org.kuali.kfs.module.endow.document
Class EndowmentAccountingLinesDocumentBase

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.module.endow.document.EndowmentTransactionalDocumentBase
                          org.kuali.kfs.module.endow.document.EndowmentTransactionLinesDocumentBase
                              org.kuali.kfs.module.endow.document.EndowmentSecurityDetailsDocumentBase
                                  org.kuali.kfs.module.endow.document.EndowmentAccountingLinesDocumentBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, EndowmentAccountingLinesDocument, EndowmentSecurityDetailsDocument, EndowmentTransactionalDocument, EndowmentTransactionLinesDocument, FinancialSystemTransactionalDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument

Direct Known Subclasses:

EndowmentToGLTransferOfFundsDocument, GLToEndowmentTransferOfFundsDocument

public abstract class EndowmentAccountingLinesDocumentBase
extends EndowmentSecurityDetailsDocumentBase
implements EndowmentAccountingLinesDocument

Provides a base class for the Endowment Transfer of Funds documents.

See Also:

Serialized Form

Field Summary

protected FinancialSystemTransactionalDocumentEntry	dataDictionaryEntry
protected Integer	nextSourceAccountingLineNumber
protected Integer	nextTargetAccountingLineNumber
protected Class	sourceAccountingLineClass
protected List<SourceEndowmentAccountingLine>	sourceAccountingLines
protected Class	targetAccountingLineClass
protected List<TargetEndowmentAccountingLine>	targetAccountingLines

Fields inherited from class org.kuali.kfs.module.endow.document.EndowmentSecurityDetailsDocumentBase

sourceTransactionSecurities, sourceTransactionSecurity, targetTransactionSecurities, targetTransactionSecurity

Fields inherited from class org.kuali.kfs.module.endow.document.EndowmentTransactionLinesDocumentBase

nextSourceLineNumber, nextTargetLineNumber, sourceTransactionLines, targetTransactionLines

Fields inherited from class org.kuali.kfs.module.endow.document.EndowmentTransactionalDocumentBase

businessObjectService, CHECK_IF_ROUTE_SPLIT, dateTimeService, noRouteIndicator, transactionPosted, transactionSourceType, transactionSourceTypeCode, transactionSubType, transactionSubTypeCode

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

documentHeader, LOG

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

EndowmentAccountingLinesDocumentBase()
Constructs a EndowmentTransferOfFundsDocument.

Method Summary

void	addSourceAccountingLine(SourceEndowmentAccountingLine line) Adds a new Source accounting line.
void	addTargetAccountingLine(TargetEndowmentAccountingLine line) Adds a new Target Accounting line.
List	buildListOfDeletionAwareLists()
FinancialSystemTransactionalDocumentEntry	getDataDictionaryEntry()
EndowmentAccountingLineParser	getEndowmentAccountingLineParser() Used to get the appropriate EndowmentAccountingLineParser for the Document
Integer	getNextSourceAccountingLineNumber() Gets the nextSourceAccountingLineNumber.
Integer	getNextTargetAccountingLineNumber() Gets the nextTargetAccountingLineNumber.
SourceEndowmentAccountingLine	getSourceAccountingLine(int index) This method returns the accounting line at a particular spot in the overall list of accounting lines.
Class	getSourceAccountingLineClass()
List<SourceEndowmentAccountingLine>	getSourceAccountingLines() Gets the sourceAccountingLines.
TargetEndowmentAccountingLine	getTargetAccountingLine(int index) This method retrieves the target accounting line at the specified index.
Class	getTargetAccountingLineClass()
List<TargetEndowmentAccountingLine>	getTargetAccountingLines() Gets the targetAccountingLines.
org.kuali.rice.kns.util.KualiDecimal	getTotalAccountingLinesAmount() Gets the total amount of the accounting lines on this document.
void	setNextSourceAccountingLineNumber(Integer nextSourceAccountingLineNumber) Sets the nextSourceAccountingLineNumber.
void	setNextTargetAccountingLineNumber(Integer nextTargetAccountingLineNumber) Sets the nextTargetAccountingLineNumber.
void	setSourceAccountingLines(List<SourceEndowmentAccountingLine> sourceAccountingLines) Sets the sourceAccountingLines.
void	setTargetAccountingLines(List<TargetEndowmentAccountingLine> targetAccountingLines) Sets the targetAccountingLines.

Methods inherited from class org.kuali.kfs.module.endow.document.EndowmentSecurityDetailsDocumentBase

getSourceTransactionSecurities, getSourceTransactionSecurity, getTargetTransactionSecurities, getTargetTransactionSecurity, prepareForSave, setSourceTransactionSecurities, setSourceTransactionSecurity, setTargetTransactionSecurities, setTargetTransactionSecurity

Methods inherited from class org.kuali.kfs.module.endow.document.EndowmentTransactionLinesDocumentBase

addSourceTransactionLine, addTargetTransactionLine, getLineParser, getNextSourceLineNumber, getNextTargetLineNumber, getSourceIncomeTotal, getSourceIncomeTotalUnits, getSourcePrincipalTotal, getSourcePrincipalTotalUnits, getSourceTotalAmount, getSourceTotalUnits, getSourceTransactionLine, getSourceTransactionLines, getSourceTransactionLinesSectionTitle, getTargetIncomeTotal, getTargetIncomeTotalUnits, getTargetPrincipalTotal, getTargetPrincipalTotalUnits, getTargetTotalAmount, getTargetTotalUnits, getTargetTransactionLine, getTargetTransactionLines, getTargetTransactionLinesSectionTitle, getTotalDollarAmount, getTotalUnits, getTranLineClass, getTransactionLineParser, setNextSourceLineNumber, setNextTargetLineNumber, setSourceTransactionLines, setTargetTransactionLines, toCopy, toErrorCorrection

Methods inherited from class org.kuali.kfs.module.endow.document.EndowmentTransactionalDocumentBase

answerSplitNodeQuestion, doRouteStatusChange, getBusinessObjectService, getDateTimeService, getNoRouteIndicator, getTransactionSourceType, getTransactionSourceTypeCode, getTransactionSubType, getTransactionSubTypeCode, initializeSourceTypeObj, initializeSubType, isErrorCorrectedDocument, isTransactionPosted, setNoRouteIndicator, setTransactionPosted, setTransactionSourceType, setTransactionSourceTypeCode, setTransactionSubType, setTransactionSubTypeCode

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

getDocumentHeader, 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, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postProcessSave, prepareForSave, 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.module.endow.document.EndowmentTransactionLinesDocument

addSourceTransactionLine, addTargetTransactionLine, getLineParser, getNextSourceLineNumber, getNextTargetLineNumber, getSourceIncomeTotal, getSourceIncomeTotalUnits, getSourcePrincipalTotal, getSourcePrincipalTotalUnits, getSourceTotalAmount, getSourceTotalUnits, getSourceTransactionLine, getSourceTransactionLines, getSourceTransactionLinesSectionTitle, getTargetIncomeTotal, getTargetIncomeTotalUnits, getTargetPrincipalTotal, getTargetPrincipalTotalUnits, getTargetTotalAmount, getTargetTotalUnits, getTargetTransactionLine, getTargetTransactionLines, getTargetTransactionLinesSectionTitle, getTotalUnits, getTranLineClass, getTransactionLineParser, setNextSourceLineNumber, setNextTargetLineNumber, setSourceTransactionLines, setTargetTransactionLines

Methods inherited from interface org.kuali.kfs.module.endow.document.EndowmentTransactionalDocument

getTransactionSourceTypeCode, getTransactionSubTypeCode, isErrorCorrectedDocument, isTransactionPosted, setNoRouteIndicator, setTransactionPosted, setTransactionSourceTypeCode, setTransactionSubTypeCode

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, 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

Field Detail

nextSourceAccountingLineNumber

protected Integer nextSourceAccountingLineNumber

nextTargetAccountingLineNumber

protected Integer nextTargetAccountingLineNumber

sourceAccountingLines

protected List<SourceEndowmentAccountingLine> sourceAccountingLines

targetAccountingLines

protected List<TargetEndowmentAccountingLine> targetAccountingLines

dataDictionaryEntry

protected transient FinancialSystemTransactionalDocumentEntry dataDictionaryEntry

sourceAccountingLineClass

protected transient Class sourceAccountingLineClass

targetAccountingLineClass

protected transient Class targetAccountingLineClass

Constructor Detail

EndowmentAccountingLinesDocumentBase

public EndowmentAccountingLinesDocumentBase()

Constructs a EndowmentTransferOfFundsDocument.

Method Detail

getNextSourceAccountingLineNumber

public Integer getNextSourceAccountingLineNumber()

Gets the nextSourceAccountingLineNumber.

Specified by:

getNextSourceAccountingLineNumber in interface EndowmentAccountingLinesDocument

Returns:

nextSourceAccountingLineNumber

setNextSourceAccountingLineNumber

public void setNextSourceAccountingLineNumber(Integer nextSourceAccountingLineNumber)

Sets the nextSourceAccountingLineNumber.

Specified by:

setNextSourceAccountingLineNumber in interface EndowmentAccountingLinesDocument

Parameters:

nextSourceAccountingLineNumber -

getNextTargetAccountingLineNumber

public Integer getNextTargetAccountingLineNumber()

Gets the nextTargetAccountingLineNumber.

Specified by:

getNextTargetAccountingLineNumber in interface EndowmentAccountingLinesDocument

Returns:

nextTargetAccountingLineNumber

setNextTargetAccountingLineNumber

public void setNextTargetAccountingLineNumber(Integer nextTargetAccountingLineNumber)

Sets the nextTargetAccountingLineNumber.

Specified by:

setNextTargetAccountingLineNumber in interface EndowmentAccountingLinesDocument

Parameters:

nextTargetAccountingLineNumber -

getSourceAccountingLines

public List<SourceEndowmentAccountingLine> getSourceAccountingLines()

Gets the sourceAccountingLines.

Specified by:

getSourceAccountingLines in interface EndowmentAccountingLinesDocument

Returns:

sourceAccountingLines

setSourceAccountingLines

public void setSourceAccountingLines(List<SourceEndowmentAccountingLine> sourceAccountingLines)

Sets the sourceAccountingLines.

Specified by:

setSourceAccountingLines in interface EndowmentAccountingLinesDocument

Parameters:

sourceAccountingLines -

getTargetAccountingLines

public List<TargetEndowmentAccountingLine> getTargetAccountingLines()

Gets the targetAccountingLines.

Specified by:

getTargetAccountingLines in interface EndowmentAccountingLinesDocument

Returns:

targetAccountingLines

setTargetAccountingLines

public void setTargetAccountingLines(List<TargetEndowmentAccountingLine> targetAccountingLines)

Sets the targetAccountingLines.

Specified by:

setTargetAccountingLines in interface EndowmentAccountingLinesDocument

Parameters:

targetAccountingLines -

addSourceAccountingLine

public void addSourceAccountingLine(SourceEndowmentAccountingLine line)

Description copied from interface: EndowmentAccountingLinesDocument

Adds a new Source accounting line.

Specified by:

addSourceAccountingLine in interface EndowmentAccountingLinesDocument

See Also:

EndowmentTransactionLinesDocument.addSourceTransactionLine(org.kuali.kfs.module.endow.businessobject.EndowmentSourceTransactionLine)

addTargetAccountingLine

public void addTargetAccountingLine(TargetEndowmentAccountingLine line)

Description copied from interface: EndowmentAccountingLinesDocument

Adds a new Target Accounting line.

Specified by:

addTargetAccountingLine in interface EndowmentAccountingLinesDocument

See Also:

EndowmentTransactionLinesDocument.addTargetTransactionLine(org.kuali.kfs.module.endow.businessobject.EndowmentTargetTransactionLine)

getSourceAccountingLine

public SourceEndowmentAccountingLine getSourceAccountingLine(int index)

Description copied from interface: EndowmentAccountingLinesDocument

This method returns the accounting line at a particular spot in the overall list of accounting lines.

Specified by:

getSourceAccountingLine in interface EndowmentAccountingLinesDocument

Returns:

The source accounting line at the specified index.

See Also:

EndowmentAccountingLinesDocument.getSourceAccountingLine(int)

getTargetAccountingLine

public TargetEndowmentAccountingLine getTargetAccountingLine(int index)

Description copied from interface: EndowmentAccountingLinesDocument

This method retrieves the target accounting line at the specified index.

Specified by:

getTargetAccountingLine in interface EndowmentAccountingLinesDocument

Returns:

The target accounting line at the passed in index.

See Also:

EndowmentAccountingLinesDocument.getTargetAccountingLine(int)

getTotalAccountingLinesAmount

public org.kuali.rice.kns.util.KualiDecimal getTotalAccountingLinesAmount()

Gets the total amount of the accounting lines on this document.

Returns:

total amount of the accounting lines

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.kns.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class EndowmentSecurityDetailsDocumentBase

See Also:

PersistableBusinessObjectBase.buildListOfDeletionAwareLists()

getEndowmentAccountingLineParser

public EndowmentAccountingLineParser getEndowmentAccountingLineParser()

Used to get the appropriate EndowmentAccountingLineParser for the Document

Specified by:

getEndowmentAccountingLineParser in interface EndowmentAccountingLinesDocument

Returns:

EndowmentAccountingLineParser

getDataDictionaryEntry

public FinancialSystemTransactionalDocumentEntry getDataDictionaryEntry()

Returns:

the data dictionary entry for this document

getSourceAccountingLineClass

public Class getSourceAccountingLineClass()

Specified by:

getSourceAccountingLineClass in interface EndowmentAccountingLinesDocument

See Also:

EndowmentAccountingLinesDocument.getSourceAccountingLineClass()

getTargetAccountingLineClass

public Class getTargetAccountingLineClass()

Specified by:

getTargetAccountingLineClass in interface EndowmentAccountingLinesDocument

See Also:

EndowmentAccountingLinesDocument.getTargetAccountingLineClass()