org.kuali.rice.kns.document
Interface MaintenanceDocument

All Superinterfaces:

BusinessObject, Document, GloballyUnique, MaintenanceDocument, ModelObjectBasic, PersistableBusinessObject, Serializable, Versioned

public interface MaintenanceDocument
extends MaintenanceDocument

Common interface for all maintenance documents.

Method Summary

PersistableBusinessObject	getDocumentBusinessObject() Returns a reference to the PersistableBusinessObject that this MaintenanceDocument is maintaining.
Maintainable	getNewMaintainableObject() Get the new maintainable object
Maintainable	getOldMaintainableObject() Get the old maintainable object
boolean	isOldBusinessObjectInDocument()

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, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, 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

Method Detail

getNewMaintainableObject

Maintainable getNewMaintainableObject()

Description copied from interface: MaintenanceDocument

Get the new maintainable object

Specified by:

getNewMaintainableObject in interface MaintenanceDocument

Returns:

Maintainable which holds the new maintenance record

getOldMaintainableObject

Maintainable getOldMaintainableObject()

Description copied from interface: MaintenanceDocument

Get the old maintainable object

Specified by:

getOldMaintainableObject in interface MaintenanceDocument

Returns:

Maintainable which holds the old maintenance record

getDocumentBusinessObject

PersistableBusinessObject getDocumentBusinessObject()

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

isOldBusinessObjectInDocument

boolean isOldBusinessObjectInDocument()

Returns:

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