org.kuali.rice.kns.document

Class MaintenanceDocumentBase

java.lang.Object

org.kuali.rice.krad.bo.DataObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.maintenance.MaintenanceDocumentBase

org.kuali.rice.kns.document.MaintenanceDocumentBase

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, Document, SessionDocument, MaintenanceDocument

Deprecated.

Use MaintenanceDocumentBase.

@Deprecated
public class MaintenanceDocumentBase
extends MaintenanceDocumentBase
implements MaintenanceDocument

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.struts.upload.FormFile	fileAttachment Deprecated.

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, SUB_OBJECT_MATERIALIZATION_DEPTH, xmlDocumentContents

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

adHocRoutePersons, adHocRouteWorkgroups, documentHeader, documentNumber, notes, pessimisticLocks

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

extension, newCollectionRecord

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

objectId, versionNumber

Constructor Summary

Constructors

Constructor and Description
MaintenanceDocumentBase() Deprecated.
MaintenanceDocumentBase(String documentTypeName) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected BusinessObjectSerializerService	getBusinessObjectSerializerService() Deprecated.
Object	getDocumentBusinessObject() Deprecated. Returns a reference to the PersistableBusinessObject that this MaintenanceDocument is maintaining.
org.apache.struts.upload.FormFile	getFileAttachment() Deprecated.
Maintainable	getNewMaintainableObject() Deprecated. Get the new maintainable object
Maintainable	getOldMaintainableObject() Deprecated. Get the old maintainable object
boolean	isOldBusinessObjectInDocument() Deprecated. Checks old maintainable bo has key values
void	populateAttachmentBeforeSave() Deprecated.
void	populateAttachmentForBO() Deprecated.
void	populateAttachmentListForBO() Deprecated.
void	populateBoAttachmentListBeforeSave() Deprecated.
void	populateDocumentAttachment() Deprecated.
void	populateDocumentAttachmentList() Deprecated.
void	postProcessSave(DocumentEvent event) Deprecated. this needs to happen after the document itself is saved, to preserve consistency of the ver_nbr and in the case of initial save, because this can't be saved until the document is saved initially
protected void	refreshAttachment() Deprecated. The attachment BO is proxied in OJB.
protected void	refreshAttachmentList() Deprecated.
void	setFileAttachment(org.apache.struts.upload.FormFile fileAttachment) Deprecated.

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

checkAllowsRecordDeletion, checkDeletePermission, checkForLockingDocument, checkMaintenanceAction, deleteDocumentAttachment, deleteDocumentAttachmentList, doRouteStatusChange, getAllowsCopy, getAttachment, getAttachmentCollectionName, getAttachmentListPropertyName, getAttachmentPropertyName, getAttachments, getCustomLockDescriptor, getDataObjectFromXML, getDocumentDataObject, getDocumentDictionaryService, getDocumentPropertySerizabilityEvaluator, getDocumentService, getDocumentTitle, getMaintenanceAction, getMaintenanceDocumentService, getNoteTarget, getNoteType, getWorkflowEngineDocumentIdsToLock, getXmlDocumentContents, isDisplayTopicFieldInNotes, isEdit, isFieldsClearedOnCopy, isNew, isNewWithExisting, isOldDataObjectInDocument, isOldMaintainableInDocument, isSessionDocument, populateMaintainablesFromXmlDocumentContents, populateXmlDocumentContentsFromMaintainables, prepareForSave, prepareForSave, processAfterRetrieve, 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, getActionRequests, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getLockClearingMethodNames, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getPessimisticLocks, getSuperUserAnnotation, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postRemove, prePersist, refreshPessimisticLocks, refreshReferenceObject, removeNote, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setNewDocumentHeader, setNotes, setPessimisticLocks, setSuperUserAnnotation, toCopy, wrapDocumentWithMetadataForXmlSerialization

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

buildListOfDeletionAwareLists, getExtension, getLegacyDataAdapter, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord

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

generateAndSetObjectIdIfNeeded, getExtensionObject, getObjectId, getVersionNumber, preUpdate, setExtensionObject, setObjectId, setVersionNumber, 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.maintenance.MaintenanceDocument

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

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

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

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

getObjectId

Field Detail

fileAttachment

protected transient org.apache.struts.upload.FormFile fileAttachment

Deprecated.

Constructor Detail

MaintenanceDocumentBase

public MaintenanceDocumentBase()

Deprecated.

MaintenanceDocumentBase

public MaintenanceDocumentBase(String documentTypeName)

Deprecated.

Method Detail

getDocumentBusinessObject

public Object getDocumentBusinessObject()

Deprecated.

Description copied from interface: MaintenanceDocument

Returns a reference to the PersistableBusinessObject that this MaintenanceDocument is maintaining.

isOldBusinessObjectInDocument

public boolean isOldBusinessObjectInDocument()

Deprecated.

Checks old maintainable bo has key values

Returns:

boolean - indicates whether this is an edit or new maintenace document by the existence of an old maintainable

getNewMaintainableObject

public Maintainable getNewMaintainableObject()

Deprecated.

Description copied from interface: MaintenanceDocument

Get the new maintainable object

Specified by:

getNewMaintainableObject in interface MaintenanceDocument

Overrides:

getNewMaintainableObject in class MaintenanceDocumentBase

Returns:

Maintainable which holds the new maintenance record

See Also:

MaintenanceDocument.getNewMaintainableObject()

getOldMaintainableObject

public Maintainable getOldMaintainableObject()

Deprecated.

Description copied from interface: MaintenanceDocument

Get the old maintainable object

Specified by:

getOldMaintainableObject in interface MaintenanceDocument

Overrides:

getOldMaintainableObject in class MaintenanceDocumentBase

Returns:

Maintainable which holds the old maintenance record

See Also:

MaintenanceDocument.getOldMaintainableObject()

getFileAttachment

public org.apache.struts.upload.FormFile getFileAttachment()

Deprecated.

setFileAttachment

public void setFileAttachment(org.apache.struts.upload.FormFile fileAttachment)

Deprecated.

refreshAttachment

protected void refreshAttachment()

Deprecated.

The attachment BO is proxied in OJB. For some reason when an attachment does not yet exist, refreshReferenceObject is not returning null and the proxy cannot be materialized. So, this method exists to properly handle the proxied attachment BO. This is a hack and should be removed post JPA migration.

Overrides:

refreshAttachment in class MaintenanceDocumentBase

refreshAttachmentList

protected void refreshAttachmentList()

Deprecated.

Overrides:

refreshAttachmentList in class MaintenanceDocumentBase

populateDocumentAttachment

public void populateDocumentAttachment()

Deprecated.

Overrides:

populateDocumentAttachment in class MaintenanceDocumentBase

populateAttachmentForBO

public void populateAttachmentForBO()

Deprecated.

Overrides:

populateAttachmentForBO in class MaintenanceDocumentBase

populateAttachmentBeforeSave

public void populateAttachmentBeforeSave()

Deprecated.

Overrides:

populateAttachmentBeforeSave in class MaintenanceDocumentBase

populateBoAttachmentListBeforeSave

public void populateBoAttachmentListBeforeSave()

Deprecated.

Overrides:

populateBoAttachmentListBeforeSave in class MaintenanceDocumentBase

populateAttachmentListForBO

public void populateAttachmentListForBO()

Deprecated.

Overrides:

populateAttachmentListForBO in class MaintenanceDocumentBase

populateDocumentAttachmentList

public void populateDocumentAttachmentList()

Deprecated.

Overrides:

populateDocumentAttachmentList in class MaintenanceDocumentBase

getBusinessObjectSerializerService

protected BusinessObjectSerializerService getBusinessObjectSerializerService()

Deprecated.

Overrides:

getBusinessObjectSerializerService in class MaintenanceDocumentBase

Returns:

the service used for serializing maintained business / data objects

postProcessSave

public void postProcessSave(DocumentEvent event)

Deprecated.

this needs to happen after the document itself is saved, to preserve consistency of the ver_nbr and in the case of initial save, because this can't be saved until the document is saved initially

Specified by:

postProcessSave in interface Document

Overrides:

postProcessSave in class MaintenanceDocumentBase

Parameters:

event - - indicates which document event was requested

See Also:

DocumentBase.postProcessSave(org.kuali.rice.krad.rules.rule.event.DocumentEvent)