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

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

All Implemented Interfaces:

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

CashDecreaseDocument, CashIncreaseDocument, CashTransferDocument, EndowmentAccountingLinesDocumentBase, EndowmentTaxLotLinesDocumentBase

public abstract class EndowmentSecurityDetailsDocumentBase
extends EndowmentTransactionLinesDocumentBase
implements EndowmentSecurityDetailsDocument

See Also:

Serialized Form

Field Summary

protected List<EndowmentTransactionSecurity>	sourceTransactionSecurities
protected EndowmentSourceTransactionSecurity	sourceTransactionSecurity
protected List<EndowmentTransactionSecurity>	targetTransactionSecurities
protected EndowmentTargetTransactionSecurity	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

EndowmentSecurityDetailsDocumentBase()

Method Summary

List	buildListOfDeletionAwareLists()
List<EndowmentTransactionSecurity>	getSourceTransactionSecurities() Gets the sourceTransactionSecurities.
EndowmentTransactionSecurity	getSourceTransactionSecurity() Here when the document is being read from the DB, the security object to be returned must be the object from the DB and not the new object created.
List<EndowmentTransactionSecurity>	getTargetTransactionSecurities() Gets the targetTransactionSecurities.
EndowmentTransactionSecurity	getTargetTransactionSecurity() Here when the document is being read from the DB, the security object to be returned must be the object from the DB and not the new object created.
void	prepareForSave() If the document has a total amount, call method on document to get the total and set in doc header.
void	setSourceTransactionSecurities(List<EndowmentTransactionSecurity> sourceTransactionSecurities) Sets the sourceTransactionSecurities.
void	setSourceTransactionSecurity(EndowmentTransactionSecurity sourceTransactionSecurity) Sets the sourceTransactionSecurity attribute value.
void	setTargetTransactionSecurities(List<EndowmentTransactionSecurity> targetTransactionSecurities) Sets the targetTransactionSecurities.
void	setTargetTransactionSecurity(EndowmentTransactionSecurity targetTransactionSecurity) Sets the targetTransactionSecurity attribute value.

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

sourceTransactionSecurities

protected List<EndowmentTransactionSecurity> sourceTransactionSecurities

targetTransactionSecurities

protected List<EndowmentTransactionSecurity> targetTransactionSecurities

sourceTransactionSecurity

protected EndowmentSourceTransactionSecurity sourceTransactionSecurity

targetTransactionSecurity

protected EndowmentTargetTransactionSecurity targetTransactionSecurity

Constructor Detail

EndowmentSecurityDetailsDocumentBase

public EndowmentSecurityDetailsDocumentBase()

Method Detail

prepareForSave

public void prepareForSave()

Description copied from class: FinancialSystemTransactionalDocumentBase

If the document has a total amount, call method on document to get the total and set in doc header.

Specified by:

prepareForSave in interface org.kuali.rice.kns.document.Document

Overrides:

prepareForSave in class FinancialSystemTransactionalDocumentBase

See Also:

FinancialSystemTransactionalDocumentBase.prepareForSave()

getSourceTransactionSecurities

public List<EndowmentTransactionSecurity> getSourceTransactionSecurities()

Gets the sourceTransactionSecurities.

Returns:

sourceTransactionSecurities

setSourceTransactionSecurities

public void setSourceTransactionSecurities(List<EndowmentTransactionSecurity> sourceTransactionSecurities)

Sets the sourceTransactionSecurities.

Parameters:

sourceTransactionSecurities -

getTargetTransactionSecurities

public List<EndowmentTransactionSecurity> getTargetTransactionSecurities()

Gets the targetTransactionSecurities.

Returns:

targetTransactionSecurities

setTargetTransactionSecurities

public void setTargetTransactionSecurities(List<EndowmentTransactionSecurity> targetTransactionSecurities)

Sets the targetTransactionSecurities.

Parameters:

targetTransactionSecurities -

getSourceTransactionSecurity

public EndowmentTransactionSecurity getSourceTransactionSecurity()

Here when the document is being read from the DB, the security object to be returned must be the object from the DB and not the new object created.

Specified by:

getSourceTransactionSecurity in interface EndowmentSecurityDetailsDocument

Returns:

Returns the sourceTransactionSecurity.

See Also:

EndowmentSecurityDetailsDocument.getSourceTransactionSecurity()

getTargetTransactionSecurity

public EndowmentTransactionSecurity getTargetTransactionSecurity()

Here when the document is being read from the DB, the security object to be returned must be the object from the DB and not the new object created.

Specified by:

getTargetTransactionSecurity in interface EndowmentSecurityDetailsDocument

Returns:

Returns the targetTransactionSecurity.

See Also:

EndowmentSecurityDetailsDocument.getTargetTransactionSecurity()

setSourceTransactionSecurity

public void setSourceTransactionSecurity(EndowmentTransactionSecurity sourceTransactionSecurity)

Description copied from interface: EndowmentSecurityDetailsDocument

Sets the sourceTransactionSecurity attribute value.

Specified by:

setSourceTransactionSecurity in interface EndowmentSecurityDetailsDocument

Parameters:

sourceTransactionSecurity - The sourceTransactionSecurity to set.

See Also:

EndowmentSecurityDetailsDocument.setSourceTransactionSecurity(org.kuali.kfs.module.endow.businessobject.EndowmentTransactionSecurity)

setTargetTransactionSecurity

public void setTargetTransactionSecurity(EndowmentTransactionSecurity targetTransactionSecurity)

Description copied from interface: EndowmentSecurityDetailsDocument

Sets the targetTransactionSecurity attribute value.

Specified by:

setTargetTransactionSecurity in interface EndowmentSecurityDetailsDocument

Parameters:

targetTransactionSecurity - The targetTransactionSecurity to set.

See Also:

EndowmentSecurityDetailsDocument.setTargetTransactionSecurity(org.kuali.kfs.module.endow.businessobject.EndowmentTransactionSecurity)

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

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

Overrides:

buildListOfDeletionAwareLists in class EndowmentTransactionLinesDocumentBase

See Also:

EndowmentTransactionLinesDocumentBase.buildListOfDeletionAwareLists()