org.kuali.kfs.module.endow.document
Interface EndowmentTransactionLinesDocument

All Superinterfaces:

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

All Known Subinterfaces:

EndowmentAccountingLinesDocument, EndowmentSecurityDetailsDocument, EndowmentTaxLotLinesDocument

All Known Implementing Classes:

AssetDecreaseDocument, AssetIncreaseDocument, CashDecreaseDocument, CashIncreaseDocument, CashTransferDocument, CorporateReorganizationDocument, CorpusAdjustmentDocument, EndowmentAccountingLinesDocumentBase, EndowmentSecurityDetailsDocumentBase, EndowmentTaxLotLinesDocumentBase, EndowmentToGLTransferOfFundsDocument, EndowmentTransactionLinesDocumentBase, EndowmentUnitShareAdjustmentDocument, GLToEndowmentTransferOfFundsDocument, HoldingAdjustmentDocument, LiabilityDecreaseDocument, LiabilityIncreaseDocument, SecurityTransferDocument

public interface EndowmentTransactionLinesDocument
extends EndowmentTransactionalDocument

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.
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	getTotalUnits() Base implementation to compute the document total units.
Class	getTranLineClass(boolean isSource)
EndowmentTransactionLineParser	getTransactionLineParser()
void	setNextSourceLineNumber(Integer nextLineNumber)
void	setNextTargetLineNumber(Integer nextLineNumber)
void	setSourceTransactionLines(List<EndowmentTransactionLine> sourceLines) This method sets the list of source transaction lines for this document.
void	setTargetTransactionLines(List<EndowmentTransactionLine> targetLines) This method sets the list of target transaction lines for this document.

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

Method Detail

getSourceTransactionLinesSectionTitle

String getSourceTransactionLinesSectionTitle()

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

Returns:

The source transaction line section's title.

getTargetTransactionLinesSectionTitle

String getTargetTransactionLinesSectionTitle()

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

Returns:

The target transaction line section's title.

getTargetIncomeTotal

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

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

getTargetPrincipalTotal

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

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

getSourceIncomeTotal

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

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

getSourcePrincipalTotal

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

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

getSourceIncomeTotalUnits

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

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

Returns:

the total income units

getSourcePrincipalTotalUnits

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

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

Returns:

the total principal units

getTargetIncomeTotalUnits

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

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

Returns:

the total income units

getTargetPrincipalTotalUnits

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

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

Returns:

the total principal units

getTargetTotalAmount

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

Compute the total amount for the target transaction lines.

Returns:

the total amount for the target transaction lines

getSourceTotalAmount

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

Compute the total amount for the source transaction lines.

Returns:

the total amount for the source transaction lines

getSourceTotalUnits

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

Computes the total units for the source transaction lines.

Returns:

the total units for the source transaction lines

getTargetTotalUnits

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

Computes the total units for the target transaction lines.

Returns:

the total units for the target transaction lines

getTotalUnits

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

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.

Returns:

the total units for the document

getTransactionLineParser

EndowmentTransactionLineParser getTransactionLineParser()

Returns:

TransactionLineParser instance appropriate for importing TransactionLines for this document type

getNextSourceLineNumber

Integer getNextSourceLineNumber()

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

Returns:

The next available source line number.

setNextSourceLineNumber

void setNextSourceLineNumber(Integer nextLineNumber)

Parameters:

nextLineNumber -

getNextTargetLineNumber

Integer getNextTargetLineNumber()

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

Returns:

The next available target line number.

setNextTargetLineNumber

void setNextTargetLineNumber(Integer nextLineNumber)

Parameters:

nextLineNumber -

addSourceTransactionLine

void addSourceTransactionLine(EndowmentSourceTransactionLine line)

This method adds a source transaction line.

Parameters:

line -

getSourceTransactionLines

List<EndowmentTransactionLine> getSourceTransactionLines()

This method returns a list of source transaction lines.

Returns:

The list of source transaction lines.

setSourceTransactionLines

void setSourceTransactionLines(List<EndowmentTransactionLine> sourceLines)

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

Parameters:

sourceLines -

addTargetTransactionLine

void addTargetTransactionLine(EndowmentTargetTransactionLine line)

This method adds a target transaction line to the document.

Parameters:

line -

getTargetTransactionLines

List<EndowmentTransactionLine> getTargetTransactionLines()

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

setTargetTransactionLines

void setTargetTransactionLines(List<EndowmentTransactionLine> targetLines)

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

Parameters:

targetLines -

getSourceTransactionLine

EndowmentSourceTransactionLine getSourceTransactionLine(int index)

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

Parameters:

index -

Returns:

The source transaction line at the specified index.

getTargetTransactionLine

EndowmentTargetTransactionLine getTargetTransactionLine(int index)

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

Parameters:

index -

Returns:

The target transaction line at the passed in index.

getTranLineClass

Class getTranLineClass(boolean isSource)

getLineParser

LineParser getLineParser()