org.kuali.kfs.sys.document
Class FinancialSystemMaintenanceDocument

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.MaintenanceDocumentBase
                  org.kuali.kfs.sys.document.FinancialSystemMaintenanceDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.MaintenanceDocument, org.kuali.rice.kns.document.SessionDocument

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

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

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

attachment, attachmentPropertyName, displayTopicFieldInNotes, fieldsClearedOnCopy, fileAttachment, MAINTAINABLE_IMPL_CLASS, MAINTENANCE_ACTION_TAG_NAME, NEW_MAINTAINABLE_TAG_NAME, newMaintainableObject, OLD_MAINTAINABLE_TAG_NAME, oldMaintainableObject, xmlDocumentContents

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

FinancialSystemMaintenanceDocument()
Constructs a FinancialSystemMaintenanceDocument.java.

FinancialSystemMaintenanceDocument(String documentTypeName)
Constructs a FinancialSystemMaintenanceDocument.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()
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.kns.bo.DocumentHeader documentHeader)

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

afterDelete, afterLookup, beforeInsert, beforeUpdate, checkAllowsRecordDeletion, checkDeletePermission, checkForLockingDocument, checkMaintenanceAction, deleteDocumentAttachment, getAllowsCopy, getAttachment, getAttachmentPropertyName, getBusinessObjectFromXML, getCustomLockDescriptor, getDisplayTopicFieldInNotes, getDocumentBusinessObject, getDocumentHeaderService, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getFileAttachment, getMaintenanceAction, getMaintenanceDocumentDictionaryService, getMaintenanceDocumentService, getNewMaintainableObject, getOldMaintainableObject, getWorkflowEngineDocumentIdsToLock, getXmlDocumentContents, isEdit, isFieldsClearedOnCopy, isNew, isNewWithExisting, isOldBusinessObjectInDocument, isOldMaintainableInDocument, isSessionDocument, populateAttachmentForBO, populateDocumentAttachment, populateMaintainablesFromXmlDocumentContents, populateXmlDocumentContentsFromMaintainables, postProcessSave, prepareForSave, prepareForSave, refreshAttachment, serializeDocumentToXml, setAttachment, setAttachmentPropertyName, setDisplayTopicFieldInNotes, setDocumentNumber, setFieldsClearedOnCopy, setFileAttachment, setNewMaintainableObject, setOldMaintainableObject, setXmlDocumentContents, toStringMapper, useCustomLockDescriptors, validateBusinessRules

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

addCopyErrorDocumentNote, addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getDocumentNumber, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getXmlForRouteReport, logErrors, populateDocumentForRouting, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, setAdHocRoutePersons, setAdHocRouteWorkgroups, setNewDocumentHeader, setPessimisticLocks, toCopy, toString, toStringBuilder, wrapDocumentWithMetadataForXmlSerialization

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

addNote, afterInsert, afterUpdate, beforeDelete, beforeInsert, 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, getBasePathToDocumentDuringSerialization, getDocumentNumber, getLockClearningMethodNames, getPessimisticLocks, getXmlForRouteReport, populateDocumentForRouting, refreshPessimisticLocks, setAdHocRoutePersons, setAdHocRouteWorkgroups, 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

afterInsert, afterUpdate, beforeDelete

Field Detail

LOG

protected static final org.apache.log4j.Logger LOG

documentHeader

protected FinancialSystemDocumentHeader documentHeader

Constructor Detail

FinancialSystemMaintenanceDocument

public FinancialSystemMaintenanceDocument()

Constructs a FinancialSystemMaintenanceDocument.java.

FinancialSystemMaintenanceDocument

public FinancialSystemMaintenanceDocument(String documentTypeName)

Constructs a FinancialSystemMaintenanceDocument.java.

Parameters:

documentTypeName -

Method Detail

getDocumentHeader

public FinancialSystemDocumentHeader getDocumentHeader()

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)

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

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

See Also:

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

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)

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.