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

All Superinterfaces:

org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.document.Document, 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, EndowmentTransactionLinesDocument

All Known Implementing Classes:

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

public interface EndowmentTransactionalDocument
extends FinancialSystemTransactionalDocument

This defines methods common for all endowment transactional documents.

Method Summary

String	getTransactionSourceTypeCode() Gets the transaction source type code
String	getTransactionSubTypeCode() Gets the transaction sub-type code
boolean	isErrorCorrectedDocument() This method return true if the document is error corrected.
boolean	isTransactionPosted() Gets the transaction posted flag.
void	setNoRouteIndicator(boolean noRouteIndicator) This is a hook into those batch processes that will generate eDocs should call this method to set the value of noRouteIndicator based on the value of NO_ROUTE_IND System parameter.
void	setTransactionPosted(boolean transactionPosted) Sets the transaction posted flag.
void	setTransactionSourceTypeCode(String transactionSourceTypeCode) Sets the transaction source type code
void	setTransactionSubTypeCode(String transactionSubTypeCode) Sets the transaction sub-type code

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

getTransactionSubTypeCode

String getTransactionSubTypeCode()

Gets the transaction sub-type code

Returns:

transaction sub-type code

setTransactionSubTypeCode

void setTransactionSubTypeCode(String transactionSubTypeCode)

Sets the transaction sub-type code

Parameters:

transactionSubTypeCode -

getTransactionSourceTypeCode

String getTransactionSourceTypeCode()

Gets the transaction source type code

Returns:

transaction source type code

setTransactionSourceTypeCode

void setTransactionSourceTypeCode(String transactionSourceTypeCode)

Sets the transaction source type code

Parameters:

transactionSourceTypeCode -

isTransactionPosted

boolean isTransactionPosted()

Gets the transaction posted flag.

Returns:

true of false depending on whether the transactions on this document have been posted or not

setTransactionPosted

void setTransactionPosted(boolean transactionPosted)

Sets the transaction posted flag.

Parameters:

transactionPosted - the value to be set

isErrorCorrectedDocument

boolean isErrorCorrectedDocument()

This method return true if the document is error corrected.

Returns:

setNoRouteIndicator

void setNoRouteIndicator(boolean noRouteIndicator)

This is a hook into those batch processes that will generate eDocs should call this method to set the value of noRouteIndicator based on the value of NO_ROUTE_IND System parameter.

Parameters:

noRouteIndicator - the value to be set