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

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

All Implemented Interfaces:

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

CorpusAdjustmentDocument, EndowmentSecurityDetailsDocumentBase

public abstract class EndowmentTransactionLinesDocumentBase
extends EndowmentTransactionalDocumentBase
implements EndowmentTransactionLinesDocument

See Also:

Serialized Form

Field Summary

protected Integer	nextSourceLineNumber
protected Integer	nextTargetLineNumber
protected List<EndowmentTransactionLine>	sourceTransactionLines
protected List<EndowmentTransactionLine>	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

EndowmentTransactionLinesDocumentBase()
Constructs a EndowmentTransactionLinesDocumentBase.java.

Method Summary

void	addSourceTransactionLine(EndowmentSourceTransactionLine line) This method adds a source transaction line.
void	addTargetTransactionLine(EndowmentTargetTransactionLine line) This method adds a target transaction line to the document.
List	buildListOfDeletionAwareLists()
LineParser	getLineParser()
Integer	getNextSourceLineNumber() Retrieves the next line sequence number for a transaction line in the Source transaction line section on an endowment transactional document.
Integer	getNextTargetLineNumber() Retrieves the next line sequence number for an transaction line in the Target transaction line section on an endowment transactional document.
org.kuali.rice.kns.util.KualiDecimal	getSourceIncomeTotal() Sums up the amounts of all of the source transaction lines for income.
org.kuali.rice.kns.util.KualiDecimal	getSourceIncomeTotalUnits() Sums up the units of all the source transaction lines for income.
org.kuali.rice.kns.util.KualiDecimal	getSourcePrincipalTotal() Sums up the amounts of all of the source transaction lines for principal.
org.kuali.rice.kns.util.KualiDecimal	getSourcePrincipalTotalUnits() Sums up the units of all source transaction lines for principal.
org.kuali.rice.kns.util.KualiDecimal	getSourceTotalAmount() Compute the total amount for the source transaction lines.
org.kuali.rice.kns.util.KualiDecimal	getSourceTotalUnits() Computes the total units for the source transaction lines.
EndowmentSourceTransactionLine	getSourceTransactionLine(int index) This method returns the transaction line at a particular spot in the overall list of transaction lines.
List<EndowmentTransactionLine>	getSourceTransactionLines() This method returns a list of source transaction lines.
String	getSourceTransactionLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source transaction line section.
org.kuali.rice.kns.util.KualiDecimal	getTargetIncomeTotal() Sums up the amounts of all of the target transaction lines for income.
org.kuali.rice.kns.util.KualiDecimal	getTargetIncomeTotalUnits() Sums up the units of all the target transaction lines for income.
org.kuali.rice.kns.util.KualiDecimal	getTargetPrincipalTotal() Sums up the amounts of all of the target transaction lines for principal.
org.kuali.rice.kns.util.KualiDecimal	getTargetPrincipalTotalUnits() Sums up the units of all source transaction lines for principal.
org.kuali.rice.kns.util.KualiDecimal	getTargetTotalAmount() Compute the total amount for the target transaction lines.
org.kuali.rice.kns.util.KualiDecimal	getTargetTotalUnits() Computes the total units for the target transaction lines.
EndowmentTargetTransactionLine	getTargetTransactionLine(int index) This method retrieves the target transaction line at the specified index.
List<EndowmentTransactionLine>	getTargetTransactionLines() This method retrieves all of the target transaction lines associated with this document.
String	getTargetTransactionLinesSectionTitle() This method is used to return the title that a transactional document should give to it's target transaction line section.
org.kuali.rice.kns.util.KualiDecimal	getTotalDollarAmount() Base implementation to compute the document total amount.
org.kuali.rice.kns.util.KualiDecimal	getTotalUnits() Base implementation to compute the document total units.
Class	getTranLineClass(boolean isSource)
EndowmentTransactionLineParser	getTransactionLineParser()
void	setNextSourceLineNumber(Integer nextSourceLineNumber)
void	setNextTargetLineNumber(Integer nextTargetLineNumber)
void	setSourceTransactionLines(List<EndowmentTransactionLine> sourceTransactionLines) This method sets the list of source transaction lines for this document.
void	setTargetTransactionLines(List<EndowmentTransactionLine> targetTransactionLines) This method sets the list of target transaction lines for this document.
void	toCopy()
void	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, 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, 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.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

nextSourceLineNumber

protected Integer nextSourceLineNumber

nextTargetLineNumber

protected Integer nextTargetLineNumber

sourceTransactionLines

protected List<EndowmentTransactionLine> sourceTransactionLines

targetTransactionLines

protected List<EndowmentTransactionLine> targetTransactionLines

Constructor Detail

EndowmentTransactionLinesDocumentBase

public EndowmentTransactionLinesDocumentBase()

Constructs a EndowmentTransactionLinesDocumentBase.java.

Method Detail

getSourceTransactionLines

public List<EndowmentTransactionLine> getSourceTransactionLines()

Description copied from interface: EndowmentTransactionLinesDocument

This method returns a list of source transaction lines.

Specified by:

getSourceTransactionLines in interface EndowmentTransactionLinesDocument

Returns:

The list of source transaction lines.

See Also:

EndowmentTransactionLinesDocument.getSourceTransactionLines()

setSourceTransactionLines

public void setSourceTransactionLines(List<EndowmentTransactionLine> sourceTransactionLines)

Description copied from interface: EndowmentTransactionLinesDocument

This method sets the list of source transaction lines for this document.

Specified by:

setSourceTransactionLines in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.setSourceTransactionLines(java.util.List)

getTargetTransactionLines

public List<EndowmentTransactionLine> getTargetTransactionLines()

Description copied from interface: EndowmentTransactionLinesDocument

This method retrieves all of the target transaction lines associated with this document.

Specified by:

getTargetTransactionLines in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.getTargetTransactionLines()

setTargetTransactionLines

public void setTargetTransactionLines(List<EndowmentTransactionLine> targetTransactionLines)

Description copied from interface: EndowmentTransactionLinesDocument

This method sets the list of target transaction lines for this document.

Specified by:

setTargetTransactionLines in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.setTargetTransactionLines(java.util.List)

getSourceTransactionLinesSectionTitle

public String getSourceTransactionLinesSectionTitle()

Description copied from interface: EndowmentTransactionLinesDocument

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

Specified by:

getSourceTransactionLinesSectionTitle in interface EndowmentTransactionLinesDocument

Returns:

The source transaction line section's title.

See Also:

EndowmentTransactionLinesDocument.getSourceTransactionLinesSectionTitle()

getTargetTransactionLinesSectionTitle

public String getTargetTransactionLinesSectionTitle()

Description copied from interface: EndowmentTransactionLinesDocument

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

Specified by:

getTargetTransactionLinesSectionTitle in interface EndowmentTransactionLinesDocument

Returns:

The target transaction line section's title.

See Also:

EndowmentTransactionLinesDocument.getTargetTransactionLinesSectionTitle()

getNextSourceLineNumber

public Integer getNextSourceLineNumber()

Description copied from interface: EndowmentTransactionLinesDocument

Retrieves the next line sequence number for a transaction line in the Source transaction line section on an endowment transactional document.

Specified by:

getNextSourceLineNumber in interface EndowmentTransactionLinesDocument

Returns:

The next available source line number.

See Also:

EndowmentTransactionLinesDocument.getNextSourceLineNumber()

setNextSourceLineNumber

public void setNextSourceLineNumber(Integer nextSourceLineNumber)

Specified by:

setNextSourceLineNumber in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.setNextSourceLineNumber(java.lang.Integer)

getNextTargetLineNumber

public Integer getNextTargetLineNumber()

Description copied from interface: EndowmentTransactionLinesDocument

Retrieves the next line sequence number for an transaction line in the Target transaction line section on an endowment transactional document.

Specified by:

getNextTargetLineNumber in interface EndowmentTransactionLinesDocument

Returns:

The next available target line number.

See Also:

EndowmentTransactionLinesDocument.getNextTargetLineNumber()

setNextTargetLineNumber

public void setNextTargetLineNumber(Integer nextTargetLineNumber)

Specified by:

setNextTargetLineNumber in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.setNextTargetLineNumber(java.lang.Integer)

addSourceTransactionLine

public void addSourceTransactionLine(EndowmentSourceTransactionLine line)

Description copied from interface: EndowmentTransactionLinesDocument

This method adds a source transaction line.

Specified by:

addSourceTransactionLine in interface EndowmentTransactionLinesDocument

See Also:

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

addTargetTransactionLine

public void addTargetTransactionLine(EndowmentTargetTransactionLine line)

Description copied from interface: EndowmentTransactionLinesDocument

This method adds a target transaction line to the document.

Specified by:

addTargetTransactionLine in interface EndowmentTransactionLinesDocument

See Also:

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

getSourceIncomeTotal

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

Description copied from interface: EndowmentTransactionLinesDocument

Sums up the amounts of all of the source transaction lines for income.

Specified by:

getSourceIncomeTotal in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.getSourceIncomeTotal()

getSourcePrincipalTotal

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

Description copied from interface: EndowmentTransactionLinesDocument

Sums up the amounts of all of the source transaction lines for principal.

Specified by:

getSourcePrincipalTotal in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.getSourcePrincipalTotal()

getTargetIncomeTotal

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

Description copied from interface: EndowmentTransactionLinesDocument

Sums up the amounts of all of the target transaction lines for income.

Specified by:

getTargetIncomeTotal in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.getTargetIncomeTotal()

getTargetPrincipalTotal

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

Description copied from interface: EndowmentTransactionLinesDocument

Sums up the amounts of all of the target transaction lines for principal.

Specified by:

getTargetPrincipalTotal in interface EndowmentTransactionLinesDocument

See Also:

EndowmentTransactionLinesDocument.getTargetPrincipalTotal()

getSourceIncomeTotalUnits

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

Description copied from interface: EndowmentTransactionLinesDocument

Sums up the units of all the source transaction lines for income.

Specified by:

getSourceIncomeTotalUnits in interface EndowmentTransactionLinesDocument

Returns:

the total income units

See Also:

EndowmentTransactionLinesDocument.getSourceIncomeTotalUnits()

getSourcePrincipalTotalUnits

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

Description copied from interface: EndowmentTransactionLinesDocument

Sums up the units of all source transaction lines for principal.

Specified by:

getSourcePrincipalTotalUnits in interface EndowmentTransactionLinesDocument

Returns:

the total principal units

See Also:

EndowmentTransactionLinesDocument.getSourcePrincipalTotalUnits()

getTargetIncomeTotalUnits

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

Description copied from interface: EndowmentTransactionLinesDocument

Sums up the units of all the target transaction lines for income.

Specified by:

getTargetIncomeTotalUnits in interface EndowmentTransactionLinesDocument

Returns:

the total income units

See Also:

EndowmentTransactionLinesDocument.getTargetIncomeTotalUnits()

getTargetPrincipalTotalUnits

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

Description copied from interface: EndowmentTransactionLinesDocument

Sums up the units of all source transaction lines for principal.

Specified by:

getTargetPrincipalTotalUnits in interface EndowmentTransactionLinesDocument

Returns:

the total principal units

See Also:

EndowmentTransactionLinesDocument.getTargetPrincipalTotalUnits()

getTransactionLineParser

public EndowmentTransactionLineParser getTransactionLineParser()

Specified by:

getTransactionLineParser in interface EndowmentTransactionLinesDocument

Returns:

TransactionLineParser instance appropriate for importing TransactionLines for this document type

See Also:

EndowmentTransactionLinesDocument.getTransactionLineParser()

getSourceTransactionLine

public EndowmentSourceTransactionLine getSourceTransactionLine(int index)

Description copied from interface: EndowmentTransactionLinesDocument

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

Specified by:

getSourceTransactionLine in interface EndowmentTransactionLinesDocument

Returns:

The source transaction line at the specified index.

See Also:

EndowmentTransactionLinesDocument.getSourceTransactionLine(int)

getTargetTransactionLine

public EndowmentTargetTransactionLine getTargetTransactionLine(int index)

Description copied from interface: EndowmentTransactionLinesDocument

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

Specified by:

getTargetTransactionLine in interface EndowmentTransactionLinesDocument

Returns:

The target transaction line at the passed in index.

See Also:

EndowmentTransactionLinesDocument.getTargetTransactionLine(int)

getTargetTotalAmount

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

Description copied from interface: EndowmentTransactionLinesDocument

Compute the total amount for the target transaction lines.

Specified by:

getTargetTotalAmount in interface EndowmentTransactionLinesDocument

Returns:

the total amount for the target transaction lines

See Also:

EndowmentTransactionLinesDocument.getTargetTotalAmount()

getSourceTotalAmount

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

Description copied from interface: EndowmentTransactionLinesDocument

Compute the total amount for the source transaction lines.

Specified by:

getSourceTotalAmount in interface EndowmentTransactionLinesDocument

Returns:

the total amount for the source transaction lines

See Also:

EndowmentTransactionLinesDocument.getSourceTotalAmount()

getTotalDollarAmount

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

Base implementation to compute the document total amount. Documents that display the total amount will implement the AmountTotaling interface and can override this method if needed.

Returns:

the total units for the document

getSourceTotalUnits

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

Description copied from interface: EndowmentTransactionLinesDocument

Computes the total units for the source transaction lines.

Specified by:

getSourceTotalUnits in interface EndowmentTransactionLinesDocument

Returns:

the total units for the source transaction lines

See Also:

EndowmentTransactionLinesDocument.getSourceTotalUnits()

getTargetTotalUnits

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

Description copied from interface: EndowmentTransactionLinesDocument

Computes the total units for the target transaction lines.

Specified by:

getTargetTotalUnits in interface EndowmentTransactionLinesDocument

Returns:

the total units for the target transaction lines

See Also:

EndowmentTransactionLinesDocument.getTargetTotalUnits()

getTotalUnits

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

Description copied from interface: EndowmentTransactionLinesDocument

Base implementation to compute the document total units. Documents that display the total units will implement the UnitsTotaling interface and can override this method if needed.

Specified by:

getTotalUnits in interface EndowmentTransactionLinesDocument

Returns:

the total units for the document

See Also:

EndowmentTransactionLinesDocument.getTotalUnits()

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

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

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

See Also:

PersistableBusinessObjectBase.buildListOfDeletionAwareLists()

toCopy

public void toCopy()
            throws org.kuali.rice.kew.exception.WorkflowException

Overrides:

toCopy in class org.kuali.rice.kns.document.DocumentBase

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

DocumentBase.toCopy()

toErrorCorrection

public void toErrorCorrection()
                       throws org.kuali.rice.kew.exception.WorkflowException,
                              IllegalStateException

Overrides:

toErrorCorrection in class EndowmentTransactionalDocumentBase

Throws:

org.kuali.rice.kew.exception.WorkflowException

IllegalStateException

See Also:

Correctable.toErrorCorrection()

getTranLineClass

public Class getTranLineClass(boolean isSource)

Specified by:

getTranLineClass in interface EndowmentTransactionLinesDocument

getLineParser

public LineParser getLineParser()

Specified by:

getLineParser in interface EndowmentTransactionLinesDocument