org.kuali.ole.sys.document

Class FinancialSystemTransactionalDocumentBase

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, FinancialSystemDocument, FinancialSystemTransactionalDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

AcquisitionBatchInputFileDocument, CloseDocument, ContractManagerAssignmentDocument, ElectronicInvoiceRejectDocument, GeneralLedgerCorrectionProcessDocument, LedgerPostingDocumentBase, ProposalAwardCloseDocument, ReceivingDocumentBase

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

This class is a OLE specific TransactionalDocumentBase class

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

documentHeader, documentNumber

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
FinancialSystemTransactionalDocumentBase() Constructs a FinancialSystemTransactionalDocumentBase.java.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	answerSplitNodeQuestion(String nodeName)
void	doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange levelChangeEvent) This is the default implementation which, if parameter KFS-SYS / Document / UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_IND is on, updates the document and resaves if needed
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.
String	getApplicationDocumentStatus() Gets the applicationDocumentStatus attribute.
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
FinancialSystemDocumentHeader	getFinancialSystemDocumentHeader()
protected FinancialSystemDocumentService	getFinancialSystemDocumentService()
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
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	setApplicationDocumentStatus(String applicationDocumentStatus) Sets the applicationDocumentStatus attribute.
void	setDocumentHeader(org.kuali.rice.krad.bo.DocumentHeader documentHeader)
void	toCopy()
void	toErrorCorrection()
void	updateAndSaveAppDocStatus(String applicationDocumentStatus) Updates status of this document and saves the workflow data

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, prepareForSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Field Detail

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

protected static final String UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

FinancialSystemTransactionalDocumentBase

public FinancialSystemTransactionalDocumentBase()

Constructs a FinancialSystemTransactionalDocumentBase.java.

Method Detail

getFinancialSystemDocumentHeader

public FinancialSystemDocumentHeader getFinancialSystemDocumentHeader()

Specified by:

getFinancialSystemDocumentHeader in interface FinancialSystemDocument

setDocumentHeader

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

Specified by:

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

Overrides:

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

See Also:

DocumentBase.setDocumentHeader(org.kuali.rice.krad.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.krad.document.Document

Overrides:

prepareForSave in class org.kuali.rice.krad.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.krad.document.Document

Overrides:

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

See Also:

Document.processAfterRetrieve()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange 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.krad.document.Document

Overrides:

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

See Also:

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

doRouteLevelChange

public void doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange levelChangeEvent)

This is the default implementation which, if parameter KFS-SYS / Document / UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_IND is on, updates the document and resaves if needed

Specified by:

doRouteLevelChange in interface org.kuali.rice.krad.document.Document

Overrides:

doRouteLevelChange in class org.kuali.rice.krad.document.DocumentBase

See Also:

org.kuali.rice.kns.document.DocumentBase#doRouteLevelChange(org.kuali.rice.kew.dto.DocumentRouteLevelChangeDTO)

toErrorCorrection

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

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

IllegalStateException

See Also:

Correctable.toErrorCorrection()

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Specified by:

answerSplitNodeQuestion in interface FinancialSystemDocument

Throws:

UnsupportedOperationException

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Returns:

the default implementation of the ParameterService

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Returns:

the default implementation of the BusinessObjectService

getFinancialSystemDocumentService

protected FinancialSystemDocumentService getFinancialSystemDocumentService()

toCopy

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

Overrides:

toCopy in class org.kuali.rice.krad.document.DocumentBase

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

IllegalStateException

updateAndSaveAppDocStatus

public void updateAndSaveAppDocStatus(String applicationDocumentStatus)
                               throws org.kuali.rice.kew.api.exception.WorkflowException

Updates status of this document and saves the workflow data

Parameters:

applicationDocumentStatus - is the app doc status to save

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

getApplicationDocumentStatus

public String getApplicationDocumentStatus()

Gets the applicationDocumentStatus attribute.

Returns:

Returns the applicationDocumentStatus

setApplicationDocumentStatus

public void setApplicationDocumentStatus(String applicationDocumentStatus)

Sets the applicationDocumentStatus attribute.

Parameters:

applicationDocumentStatus - The applicationDocumentStatus to set.