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

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.EndowmentTaxLotLinesDocumentBase
                                      org.kuali.kfs.module.endow.document.EndowmentUnitShareAdjustmentDocument

All Implemented Interfaces:

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

public class EndowmentUnitShareAdjustmentDocument
extends EndowmentTaxLotLinesDocumentBase

Endowment Unit/Share Adjustment (EUSA) transaction is available for those times when a number of units of a security held by the KEMID must be modified without affecting the original cost or carry value of the security tax lot(s).

See Also:

Serialized Form

Field Summary

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

EndowmentUnitShareAdjustmentDocument()
Constructs a EndowmentUnitShareAdjustmentDocument.java.

Method Summary

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.
void	prepareForSave() If the document has a total amount, call method on document to get the total and set in doc header.

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

buildListOfDeletionAwareLists, getTaxLotLinesNumber, toErrorCorrection

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

getSourceTransactionSecurities, getTargetTransactionSecurities, getTargetTransactionSecurity, 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

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.EndowmentSecurityDetailsDocument

getTargetTransactionSecurity, setSourceTransactionSecurity, setTargetTransactionSecurity

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

Constructor Detail

EndowmentUnitShareAdjustmentDocument

public EndowmentUnitShareAdjustmentDocument()

Constructs a EndowmentUnitShareAdjustmentDocument.java.

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 EndowmentSecurityDetailsDocumentBase

See Also:

EndowmentSecurityDetailsDocumentBase.prepareForSave()

getSourceTransactionSecurity

public EndowmentTransactionSecurity getSourceTransactionSecurity()

Description copied from class: EndowmentSecurityDetailsDocumentBase

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

Overrides:

getSourceTransactionSecurity in class EndowmentSecurityDetailsDocumentBase

Returns:

Returns the sourceTransactionSecurity.

See Also:

EndowmentSecurityDetailsDocumentBase.getSourceTransactionSecurity()