org.kuali.ole.sys.document

Class FinancialSystemMaintenanceDocument

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.maintenance.MaintenanceDocumentBase

org.kuali.rice.kns.document.MaintenanceDocumentBase

org.kuali.ole.sys.document.FinancialSystemMaintenanceDocument

All Implemented Interfaces:

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

public class FinancialSystemMaintenanceDocument
extends org.kuali.rice.kns.document.MaintenanceDocumentBase
implements FinancialSystemDocument

This class is used by the system to use financial specific objects and data for maintenance documents

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kns.document.MaintenanceDocumentBase

fileAttachment

Fields inherited from class org.kuali.rice.krad.maintenance.MaintenanceDocumentBase

attachment, attachmentCollectionName, attachmentListPropertyName, attachmentPropertyName, attachments, displayTopicFieldInNotes, fieldsClearedOnCopy, MAINTAINABLE_IMPL_CLASS, MAINTENANCE_ACTION_TAG_NAME, NEW_MAINTAINABLE_TAG_NAME, newMaintainableObject, NOTES_TAG_NAME, OLD_MAINTAINABLE_TAG_NAME, oldMaintainableObject, xmlDocumentContents

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
FinancialSystemMaintenanceDocument() Constructs a FinancialSystemMaintenanceDocument.java.
FinancialSystemMaintenanceDocument(String documentTypeName) Constructs a FinancialSystemMaintenanceDocument.java.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	answerSplitNodeQuestion(String nodeName)
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.
FinancialSystemDocumentHeader	getFinancialSystemDocumentHeader()
String	getInitiatorChartOfAccountsCode() This method is used for routing and simply returns the initiator's Chart code.
String	getInitiatorOrganizationCode() This method is used for routing and simply returns the initiator's Organization code.
protected String[]	getInitiatorPrimaryDepartmentCode() This method is a utility method that returns a String array containing the document initiator's ChartCode in the first index and the OrganizationCode in the second.
void	processAfterRetrieve() This is the default implementation which ensures that document note attachment references are loaded.
void	setDocumentHeader(org.kuali.rice.krad.bo.DocumentHeader documentHeader)

Methods inherited from class org.kuali.rice.kns.document.MaintenanceDocumentBase

getDocumentBusinessObject, getFileAttachment, getNewMaintainableObject, getOldMaintainableObject, isOldBusinessObjectInDocument, populateAttachmentBeforeSave, populateAttachmentForBO, populateAttachmentListForBO, populateBoAttachmentListBeforeSave, populateDocumentAttachment, populateDocumentAttachmentList, setFileAttachment

Methods inherited from class org.kuali.rice.krad.maintenance.MaintenanceDocumentBase

checkAllowsRecordDeletion, checkDeletePermission, checkForLockingDocument, checkMaintenanceAction, deleteDocumentAttachment, deleteDocumentAttachmentList, getAllowsCopy, getAttachment, getAttachmentCollectionName, getAttachmentListPropertyName, getAttachmentPropertyName, getAttachments, getCustomLockDescriptor, getDataObjectFromXML, getDocumentDataObject, getDocumentDictionaryService, getDocumentHeaderService, getDocumentPropertySerizabilityEvaluator, getDocumentService, getDocumentTitle, getMaintenanceAction, getMaintenanceDocumentService, getNoteTarget, getNoteType, getWorkflowEngineDocumentIdsToLock, getXmlDocumentContents, isDisplayTopicFieldInNotes, isEdit, isFieldsClearedOnCopy, isNew, isNewWithExisting, isOldDataObjectInDocument, isOldMaintainableInDocument, isSessionDocument, populateMaintainablesFromXmlDocumentContents, populateXmlDocumentContentsFromMaintainables, postLoad, postProcessSave, postRemove, prepareForSave, prepareForSave, prePersist, preUpdate, refreshAttachment, refreshAttachmentList, serializeDocumentToXml, setAttachment, setAttachmentCollectionName, setAttachmentListPropertyName, setAttachmentPropertyName, setAttachments, setDisplayTopicFieldInNotes, setDocumentNumber, setFieldsClearedOnCopy, setNewMaintainableObject, setOldMaintainableObject, setXmlDocumentContents, useCustomLockDescriptors, validateBusinessRules

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

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getPessimisticLocks, getXmlForRouteReport, logErrors, populateDocumentForRouting, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, setAdHocRoutePersons, setAdHocRouteWorkgroups, setNewDocumentHeader, setNotes, setPessimisticLocks, toCopy, 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, postUpdate, preRemove, 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, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, 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

Methods inherited from interface org.kuali.rice.krad.maintenance.MaintenanceDocument

getDocumentDataObject, getXmlDocumentContents, isDisplayTopicFieldInNotes, isEdit, isFieldsClearedOnCopy, isNew, isNewWithExisting, isOldDataObjectInDocument, populateMaintainablesFromXmlDocumentContents, populateXmlDocumentContentsFromMaintainables, setDisplayTopicFieldInNotes, setFieldsClearedOnCopy, setNewMaintainableObject, setOldMaintainableObject, setXmlDocumentContents

Constructor Detail

FinancialSystemMaintenanceDocument

public FinancialSystemMaintenanceDocument()

Constructs a FinancialSystemMaintenanceDocument.java.

FinancialSystemMaintenanceDocument

public FinancialSystemMaintenanceDocument(String documentTypeName)

Constructs a FinancialSystemMaintenanceDocument.java.

Parameters:

documentTypeName -

Method Detail

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)

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.maintenance.MaintenanceDocumentBase

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.maintenance.MaintenanceDocumentBase

See Also:

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

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)

Specified by:

answerSplitNodeQuestion in interface FinancialSystemDocument

getInitiatorChartOfAccountsCode

public String getInitiatorChartOfAccountsCode()

This method is used for routing and simply returns the initiator's Chart code.

Returns:

The Chart code of the document initiator

getInitiatorOrganizationCode

public String getInitiatorOrganizationCode()

This method is used for routing and simply returns the initiator's Organization code.

Returns:

The Organization code of the document initiator

getInitiatorPrimaryDepartmentCode

protected String[] getInitiatorPrimaryDepartmentCode()

This method is a utility method that returns a String array containing the document initiator's ChartCode in the first index and the OrganizationCode in the second.

Returns:

a String array.

getFinancialSystemDocumentHeader

public FinancialSystemDocumentHeader getFinancialSystemDocumentHeader()

Specified by:

getFinancialSystemDocumentHeader in interface FinancialSystemDocument