Package 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, Cloneable, org.eclipse.persistence.descriptors.changetracking.ChangeTracker, org.eclipse.persistence.internal.descriptors.PersistenceEntity, org.eclipse.persistence.internal.descriptors.PersistenceObject, org.eclipse.persistence.internal.weaving.PersistenceWeaved, org.eclipse.persistence.internal.weaving.PersistenceWeavedChangeTracking, org.eclipse.persistence.internal.weaving.PersistenceWeavedFetchGroups, org.eclipse.persistence.internal.weaving.PersistenceWeavedLazy, org.eclipse.persistence.internal.weaving.PersistenceWeavedRest, org.eclipse.persistence.queries.FetchGroupTracker, GloballyUnique, Versioned, MaintenanceDocument, Document, SessionDocument, MaintenanceDocument

@Deprecated
public class MaintenanceDocumentBase
extends MaintenanceDocumentBase
implements MaintenanceDocument

Deprecated.

Use MaintenanceDocumentBase.

Author:

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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTACHMENT	Deprecated.
static final String	ATTACHMENTS	Deprecated.
protected org.apache.struts.upload.FormFile	fileAttachment	Deprecated.

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

_persistence_attachment_vh, 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

_persistence_cacheKey, _persistence_fetchGroup, _persistence_href, _persistence_links, _persistence_listener, _persistence_primaryKey, _persistence_relationshipInfo, _persistence_session, _persistence_shouldRefreshFetchGroup, objectId, versionNumber

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.
Maintainable	getOldMaintainableObject()	Deprecated.
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

_persistence_get, _persistence_get_attachment, _persistence_get_attachment_vh, _persistence_get_attachments, _persistence_get_xmlDocumentContents, _persistence_initialize_attachment_vh, _persistence_new, _persistence_post_clone, _persistence_set, _persistence_set_attachment, _persistence_set_attachment_vh, _persistence_set_attachments, _persistence_set_xmlDocumentContents, checkAllowsRecordDeletion, checkDeletePermission, checkForLockingDocument, checkMaintenanceAction, deleteDocumentAttachment, deleteDocumentAttachmentList, doRouteStatusChange, getAllowsCopy, getAttachment, getAttachmentCollectionName, getAttachmentListPropertyName, getAttachmentPropertyName, getAttachments, getCustomLockDescriptor, getDataObjectFromXML, getDocumentDataObject, getDocumentDictionaryService, getDocumentPropertySerizabilityEvaluator, getDocumentService, getDocumentTitle, getMaintenanceAction, getMaintenanceDocumentService, getNoteTarget, getNoteType, getWorkflowDocumentService, getWorkflowEngineDocumentIdsToLock, getXmlDocumentContents, isAttachmentListPropertyNameRootLevel, isAttachmentPropertyNameRootLevel, 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

_persistence_get_documentNumber, _persistence_set_documentNumber, addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, generateSaveEvents, getActionRequests, getAdHocRouteNodeName, 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

_persistence_checkFetched, _persistence_checkFetchedForSet, _persistence_get_objectId, _persistence_get_versionNumber, _persistence_getCacheKey, _persistence_getFetchGroup, _persistence_getHref, _persistence_getId, _persistence_getLinks, _persistence_getPropertyChangeListener, _persistence_getRelationships, _persistence_getSession, _persistence_isAttributeFetched, _persistence_propertyChange, _persistence_resetFetchGroup, _persistence_set_objectId, _persistence_set_versionNumber, _persistence_setCacheKey, _persistence_setFetchGroup, _persistence_setHref, _persistence_setId, _persistence_setLinks, _persistence_setPropertyChangeListener, _persistence_setRelationships, _persistence_setSession, _persistence_setShouldRefreshFetchGroup, _persistence_shallow_clone, _persistence_shouldRefreshFetchGroup, 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.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, doRouteStatusChange, generateSaveEvents, getActionRequests, getAdHocRouteNodeName, 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

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.eclipse.persistence.internal.descriptors.PersistenceObject

_persistence_shallow_clone

Field Details

ATTACHMENT

public static final String ATTACHMENT

Deprecated.

See Also:

• Constant Field Values

ATTACHMENTS

public static final String ATTACHMENTS

Deprecated.

See Also:

• Constant Field Values

fileAttachment

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

Deprecated.

Constructor Details

MaintenanceDocumentBase

public MaintenanceDocumentBase()

Deprecated.

MaintenanceDocumentBase

public MaintenanceDocumentBase(String documentTypeName)

Deprecated.

Method Details

getDocumentBusinessObject

public Object getDocumentBusinessObject()

Deprecated.

Description copied from interface: MaintenanceDocument

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

Specified by:

getDocumentBusinessObject in interface MaintenanceDocument

isOldBusinessObjectInDocument

public boolean isOldBusinessObjectInDocument()

Deprecated.

Checks old maintainable bo has key values

Specified by:

isOldBusinessObjectInDocument in interface MaintenanceDocument

Returns:

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

getNewMaintainableObject

public Maintainable getNewMaintainableObject()

Deprecated.

Specified by:

getNewMaintainableObject in interface MaintenanceDocument

Specified by:

getNewMaintainableObject in interface MaintenanceDocument

Overrides:

getNewMaintainableObject in class MaintenanceDocumentBase

Returns:

Maintainable which holds the new maintenance record

getOldMaintainableObject

public Maintainable getOldMaintainableObject()

Deprecated.

Specified by:

getOldMaintainableObject in interface MaintenanceDocument

Specified by:

getOldMaintainableObject in interface MaintenanceDocument

Overrides:

getOldMaintainableObject in class MaintenanceDocumentBase

Returns:

Maintainable which holds the old maintenance record

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

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

See Also:

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