org.kuali.rice.kns.document
Interface MaintenanceDocument

All Superinterfaces:

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

All Known Implementing Classes:

MaintenanceDocumentBase

public interface MaintenanceDocument
extends Document

Common interface for all maintenance documents.

Method Summary

boolean	getDisplayTopicFieldInNotes() This method...
PersistableBusinessObject	getDocumentBusinessObject() Returns a reference to the PersistableBusinessObject that this MaintenanceDocument is maintaining.
Maintainable	getNewMaintainableObject()
Maintainable	getOldMaintainableObject()
String	getXmlDocumentContents()
boolean	isEdit() Returns true if this maintenance document is editing an existing Business Object, false if its creating a new one.
boolean	isFieldsClearedOnCopy() A flag which indicates whether the primary keys have been cleared on a Copy-type of document.
boolean	isNew() Returns true if this maintenance document is creating a new Business Object, false if its an edit.
boolean	isNewWithExisting() Returns true if this maintenance document is creating a new Business Object out of an existing Business Object, for example, a new division vendor out of an existing parent vendor.
boolean	isOldBusinessObjectInDocument()
void	populateMaintainablesFromXmlDocumentContents() Populates the old and new maintainables from the xml document contents string.
void	populateXmlDocumentContentsFromMaintainables() Builds the xml document string from the contents of the old and new maintainbles.
void	setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes) This method...
void	setFieldsClearedOnCopy(boolean keysClearedOnCopy) This method sets the value of the fieldsClearedOnCopy.
void	setNewMaintainableObject(Maintainable newMaintainableObject)
void	setOldMaintainableObject(Maintainable oldMaintainableObject)
void	setXmlDocumentContents(String documentContents) Sets the xml contents of the maintenance document

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

addNote, addPessimisticLock, 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.kns.bo.PersistableBusinessObject

buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.kns.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

getXmlDocumentContents

String getXmlDocumentContents()

Returns:

String containing the xml representation of the maintenance document

getNewMaintainableObject

Maintainable getNewMaintainableObject()

Returns:

Maintainable which holds the new maintenance record

getOldMaintainableObject

Maintainable getOldMaintainableObject()

Returns:

Maintainable which holds the old maintenance record

setXmlDocumentContents

void setXmlDocumentContents(String documentContents)

Sets the xml contents of the maintenance document

Parameters:

documentContents - - String xml

setNewMaintainableObject

void setNewMaintainableObject(Maintainable newMaintainableObject)

Parameters:

newMaintainableObject - - Initializes the new maintainable

setOldMaintainableObject

void setOldMaintainableObject(Maintainable oldMaintainableObject)

Parameters:

newMaintainableObject - - Initializes the old maintainable

getDocumentBusinessObject

PersistableBusinessObject getDocumentBusinessObject()

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

populateXmlDocumentContentsFromMaintainables

void populateXmlDocumentContentsFromMaintainables()

Builds the xml document string from the contents of the old and new maintainbles.

populateMaintainablesFromXmlDocumentContents

void populateMaintainablesFromXmlDocumentContents()

Populates the old and new maintainables from the xml document contents string.

isOldBusinessObjectInDocument

boolean isOldBusinessObjectInDocument()

Returns:

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

isNew

boolean isNew()

Returns true if this maintenance document is creating a new Business Object, false if its an edit.

isEdit

boolean isEdit()

Returns true if this maintenance document is editing an existing Business Object, false if its creating a new one.

isNewWithExisting

boolean isNewWithExisting()

Returns true if this maintenance document is creating a new Business Object out of an existing Business Object, for example, a new division vendor out of an existing parent vendor.

isFieldsClearedOnCopy

boolean isFieldsClearedOnCopy()

A flag which indicates whether the primary keys have been cleared on a Copy-type of document. This will be true if the 'clear keys on a copy' has been done, and it will be false if not.

Returns:

true if the primary keys have been cleared already, false if not.

setFieldsClearedOnCopy

void setFieldsClearedOnCopy(boolean keysClearedOnCopy)

This method sets the value of the fieldsClearedOnCopy.

Parameters:

fieldsClearedOnCopy - - true or false

getDisplayTopicFieldInNotes

boolean getDisplayTopicFieldInNotes()

This method...

Returns:

setDisplayTopicFieldInNotes

void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)

This method...