org.kuali.rice.kns.document

Class MaintenanceDocumentBase

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.maintenance.MaintenanceDocumentBase

org.kuali.rice.kns.document.MaintenanceDocumentBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, GloballyUnique, Versioned, ModelObjectBasic, BusinessObject, PersistableBusinessObject, Document, SessionDocument, MaintenanceDocument

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

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

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

documentHeader, documentNumber

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

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
MaintenanceDocumentBase()
MaintenanceDocumentBase(String documentTypeName)

Method Summary

Modifier and Type	Method and Description
PersistableBusinessObject	getDocumentBusinessObject() Returns a reference to the PersistableBusinessObject that this MaintenanceDocument is maintaining.
org.apache.struts.upload.FormFile	getFileAttachment()
Maintainable	getNewMaintainableObject() Get the new maintainable object
Maintainable	getOldMaintainableObject() Get the old maintainable object
boolean	isOldBusinessObjectInDocument() Checks old maintainable bo has key values
void	populateAttachmentBeforeSave()
void	populateAttachmentForBO()
void	populateAttachmentListForBO()
void	populateBoAttachmentListBeforeSave()
void	populateDocumentAttachment()
void	populateDocumentAttachmentList()
void	setFileAttachment(org.apache.struts.upload.FormFile fileAttachment)

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, getDocumentHeaderService, getDocumentPropertySerizabilityEvaluator, getDocumentService, getDocumentTitle, getMaintenanceAction, getMaintenanceDocumentService, getNoteTarget, getNoteType, getWorkflowEngineDocumentIdsToLock, getXmlDocumentContents, isDisplayTopicFieldInNotes, isEdit, isFieldsClearedOnCopy, isNew, isNewWithExisting, isOldDataObjectInDocument, isOldMaintainableInDocument, isSessionDocument, populateMaintainablesFromXmlDocumentContents, populateXmlDocumentContentsFromMaintainables, postLoad, postProcessSave, postRemove, prepareForSave, prepareForSave, prePersist, preUpdate, processAfterRetrieve, refreshAttachment, refreshAttachmentList, 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, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getPessimisticLocks, getXmlForRouteReport, logErrors, populateDocumentForRouting, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setNewDocumentHeader, setNotes, setPessimisticLocks, toCopy, wrapDocumentWithMetadataForXmlSerialization

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

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postUpdate, preRemove, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

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

Field Detail

fileAttachment

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

Constructor Detail

MaintenanceDocumentBase

public MaintenanceDocumentBase()

MaintenanceDocumentBase

public MaintenanceDocumentBase(String documentTypeName)

Method Detail

getDocumentBusinessObject

public PersistableBusinessObject getDocumentBusinessObject()

Description copied from interface: MaintenanceDocument

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

isOldBusinessObjectInDocument

public boolean isOldBusinessObjectInDocument()

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()

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()

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()

setFileAttachment

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

populateDocumentAttachment

public void populateDocumentAttachment()

Overrides:

populateDocumentAttachment in class MaintenanceDocumentBase

populateAttachmentForBO

public void populateAttachmentForBO()

Overrides:

populateAttachmentForBO in class MaintenanceDocumentBase

populateAttachmentBeforeSave

public void populateAttachmentBeforeSave()

Overrides:

populateAttachmentBeforeSave in class MaintenanceDocumentBase

populateBoAttachmentListBeforeSave

public void populateBoAttachmentListBeforeSave()

Overrides:

populateBoAttachmentListBeforeSave in class MaintenanceDocumentBase

populateAttachmentListForBO

public void populateAttachmentListForBO()

Overrides:

populateAttachmentListForBO in class MaintenanceDocumentBase

populateDocumentAttachmentList

public void populateDocumentAttachmentList()

Overrides:

populateDocumentAttachmentList in class MaintenanceDocumentBase