org.kuali.rice.krad.document

Class DocumentBase

java.lang.Object

org.kuali.rice.krad.bo.DataObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

org.kuali.rice.krad.document.DocumentBase

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

Direct Known Subclasses:

MaintenanceDocumentBase, org.kuali.rice.krad.document.TransactionalDocumentBase

@MappedSuperclass
public abstract class DocumentBase
extends org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter
implements org.kuali.rice.krad.document.Document

Created by sheiksalahudeenm on 9/23/14. Overridden for fixing the 'workflow document is null' issue in KRAD Transaction document with JPA. Modified method name: prePersist. Changes description : Removed the code for saving document header. Because document header will be stored by document service.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.kuali.rice.krad.bo.AdHocRoutePerson>	adHocRoutePersons
protected List<org.kuali.rice.krad.bo.AdHocRouteWorkgroup>	adHocRouteWorkgroups
protected org.kuali.rice.krad.bo.DocumentHeader	documentHeader
protected String	documentNumber
protected List<org.kuali.rice.krad.bo.Note>	notes
protected List<org.kuali.rice.krad.document.authorization.PessimisticLock>	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
DocumentBase() Constructs a DocumentBase.java.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCopyErrorDocumentNote(String noteText) Adds a note to the document indicating it was created by a copy or error correction.
void	addNote(org.kuali.rice.krad.bo.Note note)
void	addPessimisticLock(org.kuali.rice.krad.document.authorization.PessimisticLock lock)
void	afterActionTaken(org.kuali.rice.kew.api.action.ActionType performed, org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)
void	afterWorkflowEngineProcess(boolean successfullyProcessed) The the default implementation for afterWorkflowEngineProcess does nothing, but is meant to provide a hook for documents to implement for other needs.
void	beforeWorkflowEngineProcess() The the default implementation for beforeWorkflowEngineProcess does nothing, but is meant to provide a hook for documents to implement for other needs.
protected org.kuali.rice.krad.util.documentserializer.PropertySerializabilityEvaluator	createPropertySerializabilityEvaluator(org.kuali.rice.krad.datadictionary.WorkflowProperties workflowProperties, org.kuali.rice.krad.datadictionary.WorkflowAttributes workflowAttributes)
void	doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)
void	doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange levelChangeEvent) The the default implementation for RouteLevelChange does nothing, but is meant to provide a hook for documents to implement for other needs.
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
List<org.kuali.rice.krad.rules.rule.event.DocumentEvent>	generateSaveEvents() Hook for override
List<org.kuali.rice.kew.api.action.ActionRequest>	getActionRequests()
List<org.kuali.rice.krad.bo.AdHocRoutePerson>	getAdHocRoutePersons()
List<org.kuali.rice.krad.bo.AdHocRouteWorkgroup>	getAdHocRouteWorkgroups()
boolean	getAllowsCopy()
protected org.kuali.rice.krad.service.AttachmentService	getAttachmentService()
String	getBasePathToDocumentDuringSerialization() Returns the POJO property name of "this" document in the object returned by wrapDocumentWithMetadataForXmlSerialization()
String	getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user) This default implementation just throws a PessimisticLockingException.
org.kuali.rice.krad.bo.DocumentHeader	getDocumentHeader()
String	getDocumentNumber()
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.
String	getDocumentTitle() Retrieves the title of the document
List<String>	getLockClearingMethodNames() Deprecated.
List<String>	getLockClearningMethodNames() Deprecated.
protected List<String>	getNonLockingActionTakenCodes() Return the list of actions a user could take on a document which should not result in the recalculation of the PessimisticLocks.
org.kuali.rice.krad.bo.Note	getNote(int index)
List<org.kuali.rice.krad.bo.Note>	getNotes()
protected org.kuali.rice.krad.service.NoteService	getNoteService()
org.kuali.rice.core.api.mo.common.GloballyUnique	getNoteTarget() Returns the business object with which notes related to this document should be associated.
org.kuali.rice.krad.util.NoteType	getNoteType() Returns the NoteType to use for notes associated with this document.
List<org.kuali.rice.krad.document.authorization.PessimisticLock>	getPessimisticLocks()
String	getSuperUserAnnotation()
List<String>	getWorkflowEngineDocumentIdsToLock() The default implementation returns no additional ids for the workflow engine to lock prior to processing.
String	getXmlForRouteReport()
protected void	logErrors() This method logs errors.
void	populateDocumentForRouting()
protected void	postLoad() Loads the KRAD document header via the document header service.
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.DocumentEvent event)
protected void	postRemove() This overridden method is used to delete the DocumentHeader ob ject due to the system not being able to manage the DocumentHeader object via mapping files
void	prepareForSave()
void	prepareForSave(org.kuali.rice.krad.rules.rule.event.DocumentEvent event) Override this method with implementation specific prepareForSave logic
protected void	prePersist() Save the KRAD document header via the document header service.
void	processAfterRetrieve()
void	refreshPessimisticLocks()
void	refreshReferenceObject(String referenceObjectName) Deprecated. This is a KNS/OJB-related method. It should not be used on KRAD/JPA-based documents.
boolean	removeNote(org.kuali.rice.krad.bo.Note note)
String	serializeDocumentToXml()
void	setAdHocRoutePersons(List<org.kuali.rice.krad.bo.AdHocRoutePerson> adHocRoutePersons)
void	setAdHocRouteWorkgroups(List<org.kuali.rice.krad.bo.AdHocRouteWorkgroup> adHocRouteWorkgroups)
void	setDocumentHeader(org.kuali.rice.krad.bo.DocumentHeader documentHeader)
void	setDocumentNumber(String documentNumber)
protected void	setNewDocumentHeader() Gets a new document header for this documents type and sets in the document instance.
void	setNotes(List<org.kuali.rice.krad.bo.Note> notes)
void	setPessimisticLocks(List<org.kuali.rice.krad.document.authorization.PessimisticLock> pessimisticLocks)
void	setSuperUserAnnotation(String superUserAnnotation)
void	toCopy()
boolean	useCustomLockDescriptors() This default implementation simply returns false to indicate that custom lock descriptors are not supported by DocumentBase.
void	validateBusinessRules(org.kuali.rice.krad.rules.rule.event.DocumentEvent event)
org.kuali.rice.krad.workflow.KualiDocumentXmlMaterializer	wrapDocumentWithMetadataForXmlSerialization() Wraps a document in an instance of KualiDocumentXmlMaterializer, that provides additional metadata for serialization

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.core.api.mo.common.GloballyUnique

getObjectId

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

_persistence_shallow_clone

Field Detail

documentNumber

protected String documentNumber

documentHeader

protected org.kuali.rice.krad.bo.DocumentHeader documentHeader

pessimisticLocks

protected List<org.kuali.rice.krad.document.authorization.PessimisticLock> pessimisticLocks

adHocRoutePersons

protected List<org.kuali.rice.krad.bo.AdHocRoutePerson> adHocRoutePersons

adHocRouteWorkgroups

protected List<org.kuali.rice.krad.bo.AdHocRouteWorkgroup> adHocRouteWorkgroups

notes

protected List<org.kuali.rice.krad.bo.Note> notes

Constructor Detail

DocumentBase

public DocumentBase()

Constructs a DocumentBase.java.

Method Detail

getAllowsCopy

public boolean getAllowsCopy()

Specified by:

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

See Also:

Document.getAllowsCopy()

getDocumentTitle

public String getDocumentTitle()

Retrieves the title of the document

This is the default document title implementation. It concatenates the document's data dictionary file label attribute and the document's document header description together. This title is used to populate workflow and will show up in document search results and user action lists.

return String representing the title of the document

Specified by:

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

See Also:

Document.getDocumentTitle()

prepareForSave

public void prepareForSave()

Specified by:

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

See Also:

Document.prepareForSave()

processAfterRetrieve

public void processAfterRetrieve()

Specified by:

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

See Also:

Document.processAfterRetrieve()

doRouteLevelChange

public void doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange levelChangeEvent)

The the default implementation for RouteLevelChange does nothing, but is meant to provide a hook for documents to implement for other needs.

Specified by:

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

See Also:

Document.doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange)

doActionTaken

public void doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)

Specified by:

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

See Also:

Document.doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent)

afterActionTaken

public void afterActionTaken(org.kuali.rice.kew.api.action.ActionType performed,
                    org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)

Specified by:

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

See Also:

Document.afterActionTaken(org.kuali.rice.kew.api.action.ActionType, org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent)

getNonLockingActionTakenCodes

protected List<String> getNonLockingActionTakenCodes()

Return the list of actions a user could take on a document which should not result in the recalculation of the PessimisticLocks.

See Also:

doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent)

afterWorkflowEngineProcess

public void afterWorkflowEngineProcess(boolean successfullyProcessed)

The the default implementation for afterWorkflowEngineProcess does nothing, but is meant to provide a hook for documents to implement for other needs.

Specified by:

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

See Also:

Document.afterWorkflowEngineProcess(boolean)

beforeWorkflowEngineProcess

public void beforeWorkflowEngineProcess()

The the default implementation for beforeWorkflowEngineProcess does nothing, but is meant to provide a hook for documents to implement for other needs.

Specified by:

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

See Also:

Document.beforeWorkflowEngineProcess()

getWorkflowEngineDocumentIdsToLock

public List<String> getWorkflowEngineDocumentIdsToLock()

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

See Also:

Document.getWorkflowEngineDocumentIdsToLock()

toCopy

public void toCopy()
            throws org.kuali.rice.kew.api.exception.WorkflowException,
                   IllegalStateException

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

IllegalStateException

See Also:

Copyable.toCopy()

setNewDocumentHeader

protected void setNewDocumentHeader()
                             throws org.kuali.rice.kew.api.exception.WorkflowException

Gets a new document header for this documents type and sets in the document instance.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

addCopyErrorDocumentNote

protected void addCopyErrorDocumentNote(String noteText)

Adds a note to the document indicating it was created by a copy or error correction.

Parameters:

noteText - - text for note

getXmlForRouteReport

public String getXmlForRouteReport()

Specified by:

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

See Also:

Document.getXmlForRouteReport()

populateDocumentForRouting

public void populateDocumentForRouting()

Specified by:

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

See Also:

Document.populateDocumentForRouting()

serializeDocumentToXml

public String serializeDocumentToXml()

Specified by:

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

See Also:

Document.serializeDocumentToXml()

wrapDocumentWithMetadataForXmlSerialization

public org.kuali.rice.krad.workflow.KualiDocumentXmlMaterializer wrapDocumentWithMetadataForXmlSerialization()

Wraps a document in an instance of KualiDocumentXmlMaterializer, that provides additional metadata for serialization

Specified by:

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

See Also:

Document.wrapDocumentWithMetadataForXmlSerialization()

getDocumentPropertySerizabilityEvaluator

public 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. If none have been defined, then returns AlwaysTruePropertySerializibilityEvaluator.

Specified by:

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

See Also:

Document.getDocumentPropertySerizabilityEvaluator()

createPropertySerializabilityEvaluator

protected org.kuali.rice.krad.util.documentserializer.PropertySerializabilityEvaluator createPropertySerializabilityEvaluator(org.kuali.rice.krad.datadictionary.WorkflowProperties workflowProperties,
                                                                                                                  org.kuali.rice.krad.datadictionary.WorkflowAttributes workflowAttributes)

getBasePathToDocumentDuringSerialization

public String getBasePathToDocumentDuringSerialization()

Returns the POJO property name of "this" document in the object returned by wrapDocumentWithMetadataForXmlSerialization()

Specified by:

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

See Also:

Document.getBasePathToDocumentDuringSerialization()

getDocumentHeader

public org.kuali.rice.krad.bo.DocumentHeader getDocumentHeader()

Specified by:

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

setDocumentHeader

public void setDocumentHeader(org.kuali.rice.krad.bo.DocumentHeader documentHeader)

Specified by:

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

getDocumentNumber

public String getDocumentNumber()

Specified by:

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

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Specified by:

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

getAdHocRoutePersons

public List<org.kuali.rice.krad.bo.AdHocRoutePerson> getAdHocRoutePersons()

Specified by:

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

setAdHocRoutePersons

public void setAdHocRoutePersons(List<org.kuali.rice.krad.bo.AdHocRoutePerson> adHocRoutePersons)

Specified by:

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

getAdHocRouteWorkgroups

public List<org.kuali.rice.krad.bo.AdHocRouteWorkgroup> getAdHocRouteWorkgroups()

Specified by:

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

setAdHocRouteWorkgroups

public void setAdHocRouteWorkgroups(List<org.kuali.rice.krad.bo.AdHocRouteWorkgroup> adHocRouteWorkgroups)

Specified by:

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

postProcessSave

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

Specified by:

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

prepareForSave

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

Override this method with implementation specific prepareForSave logic

Specified by:

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

See Also:

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

validateBusinessRules

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

Specified by:

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

logErrors

protected void logErrors()

This method logs errors.

generateSaveEvents

public List<org.kuali.rice.krad.rules.rule.event.DocumentEvent> generateSaveEvents()

Hook for override

Specified by:

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

See Also:

Document.generateSaveEvents()

doRouteStatusChange

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

Specified by:

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

See Also:

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

getNoteTarget

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

Returns the business object with which notes related to this document should be associated. By default, the DocumentHeader of this document will be returned as the note target.

Sub classes can override this method if they want notes to be associated with something other than the document header. If this method is overridden, the getNoteType() method should be overridden to return NoteType.BUSINESS_OBJECT

Specified by:

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

Returns:

Returns the documentBusinessObject.

getNoteType

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

Returns the NoteType to use for notes associated with this document. By default this returns NoteType.DOCUMENT_HEADER since notes are associated with the DocumentHeader record by default.

The case in which this should be overridden is if getNoteTarget() is overridden to return an object other than the DocumentHeader.

Specified by:

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

Returns:

the note type to use for notes associated with this document

See Also:

Document.getNoteType()

addNote

public void addNote(org.kuali.rice.krad.bo.Note note)

Specified by:

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

See Also:

Document.addNote(org.kuali.rice.krad.bo.Note)

removeNote

public boolean removeNote(org.kuali.rice.krad.bo.Note note)

Specified by:

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

See Also:

Document.removeNote(org.kuali.rice.krad.bo.Note)

getNote

public org.kuali.rice.krad.bo.Note getNote(int index)

Specified by:

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

See Also:

Document.getNote(int)

getNotes

public List<org.kuali.rice.krad.bo.Note> getNotes()

Specified by:

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

See Also:

Document.getNotes()

setNotes

public void setNotes(List<org.kuali.rice.krad.bo.Note> notes)

Specified by:

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

See Also:

Document.setNotes(java.util.List)

getActionRequests

public List<org.kuali.rice.kew.api.action.ActionRequest> getActionRequests()

Specified by:

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

getSuperUserAnnotation

public String getSuperUserAnnotation()

Specified by:

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

setSuperUserAnnotation

public void setSuperUserAnnotation(String superUserAnnotation)

Specified by:

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

postLoad

protected void postLoad()

Loads the KRAD document header via the document header service.

See Also:

PersistableBusinessObjectBase.postLoad()

prePersist

protected void prePersist()

Save the KRAD document header via the document header service.

Overrides:

prePersist in class org.kuali.rice.krad.bo.DataObjectBase

postRemove

protected void postRemove()

This overridden method is used to delete the DocumentHeader ob ject due to the system not being able to manage the DocumentHeader object via mapping files

See Also:

PersistableBusinessObjectBase.postRemove()

getPessimisticLocks

public List<org.kuali.rice.krad.document.authorization.PessimisticLock> getPessimisticLocks()

Specified by:

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

See Also:

Document.getPessimisticLocks()

refreshPessimisticLocks

public void refreshPessimisticLocks()

Specified by:

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

See Also:

Document.refreshPessimisticLocks()

setPessimisticLocks

public void setPessimisticLocks(List<org.kuali.rice.krad.document.authorization.PessimisticLock> pessimisticLocks)

Parameters:

pessimisticLocks - the PessimisticLock objects to set

addPessimisticLock

public void addPessimisticLock(org.kuali.rice.krad.document.authorization.PessimisticLock lock)

Specified by:

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

See Also:

Document.addPessimisticLock(org.kuali.rice.krad.document.authorization.PessimisticLock)

getLockClearingMethodNames

@Deprecated
public List<String> getLockClearingMethodNames()

Deprecated.

Specified by:

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

See Also:

Document.getLockClearingMethodNames()

getLockClearningMethodNames

@Deprecated
public List<String> getLockClearningMethodNames()

Deprecated.

Specified by:

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

See Also:

Document.getLockClearingMethodNames()

useCustomLockDescriptors

public boolean useCustomLockDescriptors()

This default implementation simply returns false to indicate that custom lock descriptors are not supported by DocumentBase. If custom lock descriptors are needed, the appropriate subclasses should override this method.

Specified by:

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

See Also:

Document.useCustomLockDescriptors()

getCustomLockDescriptor

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

This default implementation just throws a PessimisticLockingException. Subclasses of DocumentBase that need support for custom lock descriptors should override this method.

Specified by:

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

See Also:

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

getAttachmentService

protected org.kuali.rice.krad.service.AttachmentService getAttachmentService()

getNoteService

protected org.kuali.rice.krad.service.NoteService getNoteService()

refreshReferenceObject

@Deprecated
public void refreshReferenceObject(String referenceObjectName)

Deprecated. This is a KNS/OJB-related method. It should not be used on KRAD/JPA-based documents.

Overrides this OJB method to accept the no-longer-bound documentHeader reference and perform the refresh via services instead of via OJB. For any other property, it works as before.

Overrides:

refreshReferenceObject in class org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

See Also:

PersistableBusinessObjectBase.refreshReferenceObject(java.lang.String)