org.kuali.kfs.sys.document
Class FinancialSystemTransactionalDocumentBase

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

All Implemented Interfaces:

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

BarcodeInventoryErrorDocument, BudgetConstructionDocument, CloseDocument, ContractManagerAssignmentDocument, EffortCertificationDocument, ElectronicInvoiceRejectDocument, EndowmentTransactionalDocumentBase, EquipmentLoanOrReturnDocument, GeneralLedgerCorrectionProcessDocument, HoldingHistoryValueAdjustmentDocument, LedgerPostingDocumentBase, ProposalAwardCloseDocument, ReceivingDocumentBase

public class FinancialSystemTransactionalDocumentBase
extends org.kuali.rice.kns.document.TransactionalDocumentBase
implements FinancialSystemTransactionalDocument

This class is a KFS specific TransactionalDocumentBase class

See Also:

Serialized Form

Field Summary

protected FinancialSystemDocumentHeader	documentHeader
protected static org.apache.log4j.Logger	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

FinancialSystemTransactionalDocumentBase()
Constructs a FinancialSystemTransactionalDocumentBase.java.

Method Summary

boolean	answerSplitNodeQuestion(String nodeName)
void	doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent) This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.
FinancialSystemDocumentHeader	getDocumentHeader()
void	prepareForSave() If the document has a total amount, call method on document to get the total and set in doc header.
void	processAfterRetrieve() This is the default implementation which ensures that document note attachment references are loaded.
void	setDocumentHeader(org.kuali.rice.kns.bo.DocumentHeader documentHeader)
void	toErrorCorrection()

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, toCopy, 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, buildListOfDeletionAwareLists, 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.rice.kns.document.Document

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, 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

Field Detail

LOG

protected static final org.apache.log4j.Logger LOG

documentHeader

protected FinancialSystemDocumentHeader documentHeader

Constructor Detail

FinancialSystemTransactionalDocumentBase

public FinancialSystemTransactionalDocumentBase()

Constructs a FinancialSystemTransactionalDocumentBase.java.

Method Detail

getDocumentHeader

public FinancialSystemDocumentHeader getDocumentHeader()

Specified by:

getDocumentHeader in interface FinancialSystemTransactionalDocument

Specified by:

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

Overrides:

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

See Also:

DocumentBase.getDocumentHeader()

setDocumentHeader

public void setDocumentHeader(org.kuali.rice.kns.bo.DocumentHeader documentHeader)

Specified by:

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

Overrides:

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

See Also:

DocumentBase.setDocumentHeader(org.kuali.rice.kns.bo.DocumentHeader)

prepareForSave

public void prepareForSave()

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 org.kuali.rice.kns.document.DocumentBase

See Also:

Document.prepareForSave()

processAfterRetrieve

public void processAfterRetrieve()

This is the default implementation which ensures that document note attachment references are loaded.

Specified by:

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

Overrides:

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

See Also:

Document.processAfterRetrieve()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)

This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.

Specified by:

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

Overrides:

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

See Also:

org.kuali.rice.kns.document.Document#doRouteStatusChange()

toErrorCorrection

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

Throws:

org.kuali.rice.kew.exception.WorkflowException

IllegalStateException

See Also:

Correctable.toErrorCorrection()

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Specified by:

answerSplitNodeQuestion in interface FinancialSystemTransactionalDocument

Throws:

UnsupportedOperationException