org.kuali.rice.krad.maintenance

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

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.PersistenceWeavedRest, org.eclipse.persistence.queries.FetchGroupTracker, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.maintenance.MaintenanceDocument

Direct Known Subclasses:

FinancialSystemMaintenanceDocument

@Entity
public class MaintenanceDocumentBase
extends DocumentBase
implements org.kuali.rice.krad.maintenance.MaintenanceDocument, org.kuali.rice.krad.document.SessionDocument

Created by sheiksalahudeenm on 10/14/14.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.bo.DocumentAttachment	attachment
protected String	attachmentCollectionName
protected String	attachmentListPropertyName
protected String	attachmentPropertyName
protected List<org.kuali.rice.krad.bo.MultiDocumentAttachment>	attachments
protected boolean	displayTopicFieldInNotes
protected boolean	fieldsClearedOnCopy
static String	MAINTAINABLE_IMPL_CLASS
static String	MAINTENANCE_ACTION_TAG_NAME
static String	NEW_MAINTAINABLE_TAG_NAME
protected org.kuali.rice.krad.maintenance.Maintainable	newMaintainableObject
static String	NOTES_TAG_NAME
static String	OLD_MAINTAINABLE_TAG_NAME
protected org.kuali.rice.krad.maintenance.Maintainable	oldMaintainableObject
protected static int	SUB_OBJECT_MATERIALIZATION_DEPTH
protected String	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_listener, _persistence_primaryKey, _persistence_relationshipInfo, _persistence_session, _persistence_shouldRefreshFetchGroup, objectId, versionNumber

Constructor Summary

Constructors

Constructor and Description
MaintenanceDocumentBase()
MaintenanceDocumentBase(String documentTypeName) Initializies the maintainables.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkAllowsRecordDeletion()
protected boolean	checkDeletePermission(Object dataObject)
protected void	checkForLockingDocument(boolean throwExceptionIfLocked)
protected boolean	checkMaintenanceAction()
void	deleteDocumentAttachment() Deprecated.
void	deleteDocumentAttachmentList() Deprecated.
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
boolean	getAllowsCopy()
org.kuali.rice.krad.bo.DocumentAttachment	getAttachment()
String	getAttachmentCollectionName()
String	getAttachmentListPropertyName()
String	getAttachmentPropertyName()
List<org.kuali.rice.krad.bo.MultiDocumentAttachment>	getAttachments()
protected org.kuali.rice.krad.service.BusinessObjectSerializerService	getBusinessObjectSerializerService()
String	getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user) Returns the custom lock descriptor generated by the new maintainable object, if defined.
protected Object	getDataObjectFromXML(String maintainableTagName) Get data object from XML
Object	getDocumentDataObject()
protected org.kuali.rice.krad.service.DocumentDictionaryService	getDocumentDictionaryService()
org.kuali.rice.krad.util.documentserializer.PropertySerializabilityEvaluator	getDocumentPropertySerizabilityEvaluator() If workflowProperties have been defined within the data dictionary for this document, then it returns an instance of BusinessObjectPropertySerializibilityEvaluator initialized with the properties.
protected org.kuali.rice.krad.service.DocumentService	getDocumentService()
String	getDocumentTitle() Builds out the document title for maintenance documents
String	getInitiatorChartOfAccountsCode() This method is used for routing and simply returns the initiator's Chart code.
String	getInitiatorOrganizationCode() This method is used for routing and simply returns the initiator's Organization code.
protected String[]	getInitiatorPrimaryDepartmentCode()
protected String	getMaintenanceAction(Document xmlDocument, String oldOrNewElementName) This method is a lame containment of ugly DOM walking code.
protected org.kuali.rice.krad.service.MaintenanceDocumentService	getMaintenanceDocumentService()
org.kuali.rice.krad.maintenance.Maintainable	getNewMaintainableObject()
org.kuali.rice.core.api.mo.common.GloballyUnique	getNoteTarget() The Note target for maintenance documents is determined by whether or not the underlying Maintainable supports business object notes or not.
org.kuali.rice.krad.util.NoteType	getNoteType() The NoteType for maintenance documents is determined by whether or not the underlying Maintainable supports business object notes or not.
org.kuali.rice.krad.maintenance.Maintainable	getOldMaintainableObject()
List<String>	getWorkflowEngineDocumentIdsToLock() The default implementation returns no additional ids for the workflow engine to lock prior to processing.
String	getXmlDocumentContents()
boolean	isDisplayTopicFieldInNotes()
boolean	isEdit()
boolean	isFieldsClearedOnCopy()
boolean	isNew()
boolean	isNewWithExisting()
boolean	isOldDataObjectInDocument()
protected boolean	isOldMaintainableInDocument(Document xmlDocument) Check if oldMaintainable is specified in the XML of the maintenance document
boolean	isSessionDocument() This method to check whether the document class implements SessionDocument TODO: move to KNS maintenance document base
void	populateAttachmentBeforeSave() Deprecated.
void	populateAttachmentForBO() Deprecated.
void	populateAttachmentListForBO() Deprecated.
void	populateBoAttachmentListBeforeSave() Deprecated.
void	populateDocumentAttachment() Deprecated.
void	populateDocumentAttachmentList() Deprecated.
void	populateMaintainablesFromXmlDocumentContents()
void	populateXmlDocumentContentsFromMaintainables() Populates the xml document contents from the maintainables.
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.DocumentEvent event) 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
void	prepareForSave()
void	prepareForSave(org.kuali.rice.krad.rules.rule.event.DocumentEvent event) Override this method with implementation specific prepareForSave logic
void	processAfterRetrieve()
protected void	refreshAttachment() Deprecated.
protected void	refreshAttachmentList() Deprecated.
String	serializeDocumentToXml() Overridden to avoid serializing the xml twice, because of the xmlDocumentContents property of this object
void	setAttachment(org.kuali.rice.krad.bo.DocumentAttachment attachment)
void	setAttachmentCollectionName(String attachmentCollectionName)
void	setAttachmentListPropertyName(String attachmentListPropertyName)
void	setAttachmentPropertyName(String attachmentPropertyName)
void	setAttachments(List<org.kuali.rice.krad.bo.MultiDocumentAttachment> attachments)
void	setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)
void	setDocumentNumber(String documentNumber)
void	setFieldsClearedOnCopy(boolean fieldsClearedOnCopy)
void	setNewMaintainableObject(org.kuali.rice.krad.maintenance.Maintainable newMaintainableObject)
void	setOldMaintainableObject(org.kuali.rice.krad.maintenance.Maintainable oldMaintainableObject)
void	setXmlDocumentContents(String xmlDocumentContents)
boolean	useCustomLockDescriptors() Returns whether or not the new maintainable object supports custom lock descriptors.
void	validateBusinessRules(org.kuali.rice.krad.rules.rule.event.DocumentEvent event) Explicitly NOT calling super here.

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

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

_persistence_get, _persistence_new, _persistence_post_clone, _persistence_set, 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_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_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, generateSaveEvents, getActionRequests, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getLockClearingMethodNames, getLockClearningMethodNames, getNote, getNotes, getPessimisticLocks, getSuperUserAnnotation, getXmlForRouteReport, populateDocumentForRouting, refreshPessimisticLocks, removeNote, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setNotes, setSuperUserAnnotation, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.eclipse.persistence.internal.descriptors.PersistenceObject

_persistence_shallow_clone

Field Detail

SUB_OBJECT_MATERIALIZATION_DEPTH

protected static final int SUB_OBJECT_MATERIALIZATION_DEPTH

See Also:

Constant Field Values

MAINTAINABLE_IMPL_CLASS

public static final String MAINTAINABLE_IMPL_CLASS

See Also:

Constant Field Values

OLD_MAINTAINABLE_TAG_NAME

public static final String OLD_MAINTAINABLE_TAG_NAME

See Also:

Constant Field Values

NEW_MAINTAINABLE_TAG_NAME

public static final String NEW_MAINTAINABLE_TAG_NAME

See Also:

Constant Field Values

MAINTENANCE_ACTION_TAG_NAME

public static final String MAINTENANCE_ACTION_TAG_NAME

See Also:

Constant Field Values

NOTES_TAG_NAME

public static final String NOTES_TAG_NAME

See Also:

Constant Field Values

oldMaintainableObject

protected org.kuali.rice.krad.maintenance.Maintainable oldMaintainableObject

newMaintainableObject

protected org.kuali.rice.krad.maintenance.Maintainable newMaintainableObject

xmlDocumentContents

protected String xmlDocumentContents

fieldsClearedOnCopy

protected boolean fieldsClearedOnCopy

displayTopicFieldInNotes

protected boolean displayTopicFieldInNotes

attachmentPropertyName

protected String attachmentPropertyName

attachmentListPropertyName

protected String attachmentListPropertyName

attachmentCollectionName

protected String attachmentCollectionName

attachment

protected org.kuali.rice.krad.bo.DocumentAttachment attachment

attachments

protected List<org.kuali.rice.krad.bo.MultiDocumentAttachment> attachments

Constructor Detail

MaintenanceDocumentBase

public MaintenanceDocumentBase()

MaintenanceDocumentBase

public MaintenanceDocumentBase(String documentTypeName)

Initializies the maintainables.

Method Detail

getDocumentTitle

public String getDocumentTitle()

Builds out the document title for maintenance documents

This will get loaded into the flex doc and passed into workflow. It will be searchable.

Specified by:

getDocumentTitle in interface org.kuali.rice.krad.document.Document

Overrides:

getDocumentTitle in class DocumentBase

Returns:

document title

See Also:

Document.getDocumentTitle()

isOldMaintainableInDocument

protected boolean isOldMaintainableInDocument(Document xmlDocument)

Check if oldMaintainable is specified in the XML of the maintenance document

Parameters:

xmlDocument - Maintenance document in XML form

Returns:

true if an oldMainainable exists in the xmlDocument, false otherwise

isOldDataObjectInDocument

public boolean isOldDataObjectInDocument()

Specified by:

isOldDataObjectInDocument in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

Maintainable.isOldDataObjectInDocument()

isNew

public boolean isNew()

Specified by:

isNew in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.isNew()

isEdit

public boolean isEdit()

Specified by:

isEdit in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.isEdit()

isNewWithExisting

public boolean isNewWithExisting()

Specified by:

isNewWithExisting in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.isNewWithExisting()

populateMaintainablesFromXmlDocumentContents

public void populateMaintainablesFromXmlDocumentContents()

Specified by:

populateMaintainablesFromXmlDocumentContents in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.populateMaintainablesFromXmlDocumentContents()

getMaintenanceAction

protected String getMaintenanceAction(Document xmlDocument,
                          String oldOrNewElementName)

This method is a lame containment of ugly DOM walking code. This is ONLY necessary because of the version conflicts between Xalan.jar in 2.6.x and 2.7. As soon as we can upgrade to 2.7, this will be switched to using XPath, which is faster and much easier on the eyes.

Parameters:

xmlDocument -

oldOrNewElementName - - String oldMaintainableObject or newMaintainableObject

Returns:

the value of the element, or null if none was there

getDataObjectFromXML

protected Object getDataObjectFromXML(String maintainableTagName)

Get data object from XML

Retrieves substring of document contents from maintainable tag name. Then use xml service to translate xml into a business object.

Parameters:

maintainableTagName - the xml tag name of the maintainable

Returns:

data object

populateXmlDocumentContentsFromMaintainables

public void populateXmlDocumentContentsFromMaintainables()

Populates the xml document contents from the maintainables.

Specified by:

populateXmlDocumentContentsFromMaintainables in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.populateXmlDocumentContentsFromMaintainables()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

Specified by:

doRouteStatusChange in interface org.kuali.rice.krad.document.Document

Overrides:

doRouteStatusChange in class DocumentBase

See Also:

DocumentBase.doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange)

getWorkflowEngineDocumentIdsToLock

public List<String> getWorkflowEngineDocumentIdsToLock()

Description copied from class: DocumentBase

The default implementation returns no additional ids for the workflow engine to lock prior to processing.

Specified by:

getWorkflowEngineDocumentIdsToLock in interface org.kuali.rice.krad.document.Document

Overrides:

getWorkflowEngineDocumentIdsToLock in class DocumentBase

See Also:

DocumentBase.getWorkflowEngineDocumentIdsToLock()

prepareForSave

public void prepareForSave()

Specified by:

prepareForSave in interface org.kuali.rice.krad.document.Document

Overrides:

prepareForSave in class DocumentBase

See Also:

Document.prepareForSave()

processAfterRetrieve

public void processAfterRetrieve()

Specified by:

processAfterRetrieve in interface org.kuali.rice.krad.document.Document

Overrides:

processAfterRetrieve in class DocumentBase

See Also:

DocumentBase.processAfterRetrieve()

getNewMaintainableObject

public org.kuali.rice.krad.maintenance.Maintainable getNewMaintainableObject()

Specified by:

getNewMaintainableObject in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.getNewMaintainableObject()

setNewMaintainableObject

public void setNewMaintainableObject(org.kuali.rice.krad.maintenance.Maintainable newMaintainableObject)

Specified by:

setNewMaintainableObject in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.setNewMaintainableObject(Maintainable)

getOldMaintainableObject

public org.kuali.rice.krad.maintenance.Maintainable getOldMaintainableObject()

Specified by:

getOldMaintainableObject in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.getOldMaintainableObject()

setOldMaintainableObject

public void setOldMaintainableObject(org.kuali.rice.krad.maintenance.Maintainable oldMaintainableObject)

Specified by:

setOldMaintainableObject in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.setOldMaintainableObject(Maintainable)

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Description copied from class: DocumentBase

Specified by:

setDocumentNumber in interface org.kuali.rice.krad.document.Document

Overrides:

setDocumentNumber in class DocumentBase

See Also:

DocumentBase.setDocumentNumber(java.lang.String)

isFieldsClearedOnCopy

public final boolean isFieldsClearedOnCopy()

Specified by:

isFieldsClearedOnCopy in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.isFieldsClearedOnCopy()

setFieldsClearedOnCopy

public final void setFieldsClearedOnCopy(boolean fieldsClearedOnCopy)

Specified by:

setFieldsClearedOnCopy in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.setFieldsClearedOnCopy(boolean)

getXmlDocumentContents

public String getXmlDocumentContents()

Specified by:

getXmlDocumentContents in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.getXmlDocumentContents()

setXmlDocumentContents

public void setXmlDocumentContents(String xmlDocumentContents)

Specified by:

setXmlDocumentContents in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.setXmlDocumentContents(String)

getAllowsCopy

public boolean getAllowsCopy()

Specified by:

getAllowsCopy in interface org.kuali.rice.krad.document.Document

Overrides:

getAllowsCopy in class DocumentBase

See Also:

Document.getAllowsCopy()

isDisplayTopicFieldInNotes

public boolean isDisplayTopicFieldInNotes()

Specified by:

isDisplayTopicFieldInNotes in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.isDisplayTopicFieldInNotes()

setDisplayTopicFieldInNotes

public void setDisplayTopicFieldInNotes(boolean displayTopicFieldInNotes)

Specified by:

setDisplayTopicFieldInNotes in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.setDisplayTopicFieldInNotes(boolean)

serializeDocumentToXml

public String serializeDocumentToXml()

Overridden to avoid serializing the xml twice, because of the xmlDocumentContents property of this object

Specified by:

serializeDocumentToXml in interface org.kuali.rice.krad.document.Document

Overrides:

serializeDocumentToXml in class DocumentBase

See Also:

Document.serializeDocumentToXml()

prepareForSave

public void prepareForSave(org.kuali.rice.krad.rules.rule.event.DocumentEvent event)

Description copied from class: DocumentBase

Override this method with implementation specific prepareForSave logic

Specified by:

prepareForSave in interface org.kuali.rice.krad.document.Document

Overrides:

prepareForSave in class DocumentBase

See Also:

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

refreshAttachment

@Deprecated
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.

refreshAttachmentList

@Deprecated
protected void refreshAttachmentList()

Deprecated.

populateAttachmentForBO

@Deprecated
public void populateAttachmentForBO()

Deprecated.

populateDocumentAttachment

@Deprecated
public void populateDocumentAttachment()

Deprecated.

populateAttachmentListForBO

@Deprecated
public void populateAttachmentListForBO()

Deprecated.

populateAttachmentBeforeSave

@Deprecated
public void populateAttachmentBeforeSave()

Deprecated.

populateDocumentAttachmentList

@Deprecated
public void populateDocumentAttachmentList()

Deprecated.

populateBoAttachmentListBeforeSave

@Deprecated
public void populateBoAttachmentListBeforeSave()

Deprecated.

deleteDocumentAttachment

@Deprecated
public void deleteDocumentAttachment()

Deprecated.

deleteDocumentAttachmentList

@Deprecated
public void deleteDocumentAttachmentList()

Deprecated.

validateBusinessRules

public void validateBusinessRules(org.kuali.rice.krad.rules.rule.event.DocumentEvent event)

Explicitly NOT calling super here. This is a complete override of the validation rules behavior.

Specified by:

validateBusinessRules in interface org.kuali.rice.krad.document.Document

Overrides:

validateBusinessRules in class DocumentBase

See Also:

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

checkForLockingDocument

protected void checkForLockingDocument(boolean throwExceptionIfLocked)

postProcessSave

public void postProcessSave(org.kuali.rice.krad.rules.rule.event.DocumentEvent event)

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 org.kuali.rice.krad.document.Document

Overrides:

postProcessSave in class DocumentBase

See Also:

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

getDocumentDataObject

public Object getDocumentDataObject()

Specified by:

getDocumentDataObject in interface org.kuali.rice.krad.maintenance.MaintenanceDocument

See Also:

MaintenanceDocument.getDocumentDataObject()

getNoteTarget

public org.kuali.rice.core.api.mo.common.GloballyUnique getNoteTarget()

The Note target for maintenance documents is determined by whether or not the underlying Maintainable supports business object notes or not. This is determined via a call to Maintainable.isNotesEnabled(). The note target is then derived as follows:

• If the Maintainable supports business object notes, delegate to getDocumentDataObject().
• Otherwise, delegate to the default implementation of getNoteTarget on the superclass which will effectively return a reference to the DocumentHeader.

Specified by:

getNoteTarget in interface org.kuali.rice.krad.document.Document

Overrides:

getNoteTarget in class DocumentBase

Returns:

Returns the documentBusinessObject.

See Also:

Document.getNoteTarget()

getNoteType

public org.kuali.rice.krad.util.NoteType getNoteType()

The NoteType for maintenance documents is determined by whether or not the underlying Maintainable supports business object notes or not. This is determined via a call to Maintainable.isNotesEnabled(). The NoteType is then derived as follows:

• If the Maintainable supports business object notes, return NoteType.BUSINESS_OBJECT.
• Otherwise, delegate to DocumentBase.getNoteType()

Specified by:

getNoteType in interface org.kuali.rice.krad.document.Document

Overrides:

getNoteType in class DocumentBase

Returns:

the note type to use for notes associated with this document

See Also:

Document.getNoteType(), Document.getNoteTarget()

getDocumentPropertySerizabilityEvaluator

public org.kuali.rice.krad.util.documentserializer.PropertySerializabilityEvaluator getDocumentPropertySerizabilityEvaluator()

Description copied from class: DocumentBase

If workflowProperties have been defined within the data dictionary for this document, then it returns an instance of BusinessObjectPropertySerializibilityEvaluator initialized with the properties. If none have been defined, then returns AlwaysTruePropertySerializibilityEvaluator.

Specified by:

getDocumentPropertySerizabilityEvaluator in interface org.kuali.rice.krad.document.Document

Overrides:

getDocumentPropertySerizabilityEvaluator in class DocumentBase

See Also:

Document.getDocumentPropertySerizabilityEvaluator()

getAttachment

public org.kuali.rice.krad.bo.DocumentAttachment getAttachment()

setAttachment

public void setAttachment(org.kuali.rice.krad.bo.DocumentAttachment attachment)

getAttachments

public List<org.kuali.rice.krad.bo.MultiDocumentAttachment> getAttachments()

setAttachments

public void setAttachments(List<org.kuali.rice.krad.bo.MultiDocumentAttachment> attachments)

getAttachmentPropertyName

public String getAttachmentPropertyName()

setAttachmentPropertyName

public void setAttachmentPropertyName(String attachmentPropertyName)

getAttachmentListPropertyName

public String getAttachmentListPropertyName()

setAttachmentListPropertyName

public void setAttachmentListPropertyName(String attachmentListPropertyName)

getAttachmentCollectionName

public String getAttachmentCollectionName()

setAttachmentCollectionName

public void setAttachmentCollectionName(String attachmentCollectionName)

isSessionDocument

public boolean isSessionDocument()

This method to check whether the document class implements SessionDocument TODO: move to KNS maintenance document base

Returns:

true if the document is a session document

useCustomLockDescriptors

public boolean useCustomLockDescriptors()

Returns whether or not the new maintainable object supports custom lock descriptors. Will always return false if the new maintainable is null.

Specified by:

useCustomLockDescriptors in interface org.kuali.rice.krad.document.Document

Overrides:

useCustomLockDescriptors in class DocumentBase

See Also:

Document.useCustomLockDescriptors(), Maintainable.useCustomLockDescriptors()

getCustomLockDescriptor

public String getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)

Returns the custom lock descriptor generated by the new maintainable object, if defined. Will throw a PessimisticLockingException if the new maintainable is null.

Specified by:

getCustomLockDescriptor in interface org.kuali.rice.krad.document.Document

Overrides:

getCustomLockDescriptor in class DocumentBase

See Also:

Document.getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person), Maintainable.getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person)

getDocumentDictionaryService

protected org.kuali.rice.krad.service.DocumentDictionaryService getDocumentDictionaryService()

getMaintenanceDocumentService

protected org.kuali.rice.krad.service.MaintenanceDocumentService getMaintenanceDocumentService()

getDocumentService

protected org.kuali.rice.krad.service.DocumentService getDocumentService()

getBusinessObjectSerializerService

protected org.kuali.rice.krad.service.BusinessObjectSerializerService getBusinessObjectSerializerService()

Returns:

the service used for serializing maintained business / data objects

checkAllowsRecordDeletion

protected boolean checkAllowsRecordDeletion()

checkMaintenanceAction

protected boolean checkMaintenanceAction()

checkDeletePermission

protected boolean checkDeletePermission(Object dataObject)

getInitiatorChartOfAccountsCode

public String getInitiatorChartOfAccountsCode()

This method is used for routing and simply returns the initiator's Chart code.

Returns:

The Chart code of the document initiator

getInitiatorPrimaryDepartmentCode

protected String[] getInitiatorPrimaryDepartmentCode()

getInitiatorOrganizationCode

public String getInitiatorOrganizationCode()

This method is used for routing and simply returns the initiator's Organization code.

Returns:

The Organization code of the document initiator