org.kuali.rice.krad.maintenance
Interface MaintenanceDocument

All Superinterfaces:

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

All Known Subinterfaces:

MaintenanceDocument

All Known Implementing Classes:

MaintenanceDocumentBase, MaintenanceDocumentBase

public interface MaintenanceDocument
extends Document

Common interface for all maintenance documents.

Method Summary

Object	getDocumentDataObject() Return the data object that this MaintenanceDocument is maintaining
Maintainable	getNewMaintainableObject() Get the new maintainable object
Maintainable	getOldMaintainableObject() Get the old maintainable object
String	getXmlDocumentContents() Get the XML representation of the maintenance document
boolean	isDisplayTopicFieldInNotes() Check if the topic field should be displayed in the notes section
boolean	isEdit() Check if maintenance document is editing an existing Business Object
boolean	isFieldsClearedOnCopy() Check if fields are cleared on copy
boolean	isNew() Check if maintenance document is creating a new Business Object
boolean	isNewWithExisting() Check if maintenance document is creating a new Business Object out of an existing Business Object
boolean	isOldDataObjectInDocument() Check if maintenance document has old maintenance data
void	populateMaintainablesFromXmlDocumentContents() Populates the old and new maintainables from the xml document contents string.
void	populateXmlDocumentContentsFromMaintainables() Build the xml document string from the contents of the old and new maintainables.
void	setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes) Set the display topic field in notes flag
void	setFieldsClearedOnCopy(boolean keysClearedOnCopy) Set the keys cleared on copy flag
void	setNewMaintainableObject(Maintainable newMaintainableObject) Set the new maintainable object
void	setOldMaintainableObject(Maintainable oldMaintainableObject) Set the old maintainable object
void	setXmlDocumentContents(String documentContents) Sets the xml contents of the maintenance document

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

getXmlDocumentContents

String getXmlDocumentContents()

Get the XML representation of the maintenance document

Returns:

String containing the xml representation of the maintenance document

getNewMaintainableObject

Maintainable getNewMaintainableObject()

Get the new maintainable object

Returns:

Maintainable which holds the new maintenance record

getOldMaintainableObject

Maintainable getOldMaintainableObject()

Get the old maintainable object

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)

Set the new maintainable object

Parameters:

newMaintainableObject - maintainable with the new maintenance record

setOldMaintainableObject

void setOldMaintainableObject(Maintainable oldMaintainableObject)

Set the old maintainable object

Parameters:

oldMaintainableObject - maintainable with the old maintenance record

getDocumentDataObject

Object getDocumentDataObject()

Return the data object that this MaintenanceDocument is maintaining

Returns:

document data object instance

populateXmlDocumentContentsFromMaintainables

void populateXmlDocumentContentsFromMaintainables()

Build the xml document string from the contents of the old and new maintainables.

populateMaintainablesFromXmlDocumentContents

void populateMaintainablesFromXmlDocumentContents()

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

isOldDataObjectInDocument

boolean isOldDataObjectInDocument()

Check if maintenance document has old maintenance data

Returns:

true if this maintenance document has old data, false otherwise

isNew

boolean isNew()

Check if maintenance document is creating a new Business Object

Returns:

true if this maintenance document is creating a new Business Object, false otherwise

isEdit

boolean isEdit()

Check if maintenance document is editing an existing Business Object

Returns:

true if this maintenance document is editing an existing Business Object, false otherwise

isNewWithExisting

boolean isNewWithExisting()

Check if 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.

Returns:

true if maintenance document is creating a new Business Object out of an existing Business object, false otherwise

isFieldsClearedOnCopy

boolean isFieldsClearedOnCopy()

Check if fields are cleared on copy

For copy action the primary keys need to be cleared. This flag indicates if the clearing has occurred.

Returns:

true if the primary keys have been cleared already, false otherwise

setFieldsClearedOnCopy

void setFieldsClearedOnCopy(boolean keysClearedOnCopy)

Set the keys cleared on copy flag

Parameters:

keysClearedOnCopy -

isDisplayTopicFieldInNotes

boolean isDisplayTopicFieldInNotes()

Check if the topic field should be displayed in the notes section

Returns:

true if the topic field should be displayed in the notes section, false otherwise

setDisplayTopicFieldInNotes

void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)

Set the display topic field in notes flag