org.kuali.kra.document

Class ResearchDocumentBase

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.document.TransactionalDocumentBase

org.kuali.kra.document.ResearchDocumentBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

BudgetDocument, BudgetParentDocument, CoiDisclosureDocument, CommitteeDocumentBase, InstitutionalProposalDocument, NegotiationDocument, PersonMassChangeDocument, ProtocolDocumentBase, ProtocolOnlineReviewDocumentBase, SubAwardDocument, TimeAndMoneyDocument

public abstract class ResearchDocumentBase
extends org.kuali.rice.krad.document.TransactionalDocumentBase

See Also:

Serialized Form

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	answerSplitNodeQuestion(String routeNodeName) In documents that support it, this method should answer T/F for a SplitNode question regarding routing.
protected List<RolePersons>	getAllRolePersons() Get the list of roles for the document along with each of the individuals in those roles.
CustomAttributeDocument	getCustomAttributeDocument(String key) Gets the customAttributeDocuments attribute.
Map<String,CustomAttributeDocument>	getCustomAttributeDocuments() This method populates the customAttributes for this document.
abstract List<? extends DocumentCustomData>	getDocumentCustomData()
Integer	getDocumentNextValue(String propertyName)
DocumentNextvalue	getDocumentNextvalueBo(String propertyName)
List<DocumentNextvalue>	getDocumentNextvalues()
abstract String	getDocumentTypeCode()
protected <T> T	getService(Class<T> serviceClass) Lookups and returns a service class.
Timestamp	getUpdateTimestamp()
String	getUpdateUser()
void	initialize()
abstract boolean	isProcessComplete() Returns whether the post-processing is considered complete for this document.
boolean	isViewOnly()
void	populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes)
void	prepareForSave()
void	processAfterRetrieve()
void	setCustomAttributeDocuments(Map<String,CustomAttributeDocument> customAttributeDocuments) Sets the customAttributeDocuments attribute value.
void	setDocumentNextvalues(List<DocumentNextvalue> documentNextvalues)
void	setUpdateTimestamp(Timestamp updateTimestamp)
void	setUpdateUser(String updateUser)
void	setViewOnly(boolean viewOnly)
void	toCopy()
void	updateDocumentDescriptions(List<BudgetDocumentVersion> budgetVersionOverviews)
void	validateBusinessRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event) Override to provide more meaningful error message
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.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

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

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, prepareForSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors

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, postRemove, postUpdate, prePersist, preRemove, preUpdate, 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.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors

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

Constructor Detail

ResearchDocumentBase

public ResearchDocumentBase()

Method Detail

initialize

public void initialize()

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class org.kuali.rice.krad.document.DocumentBase

processAfterRetrieve

public void processAfterRetrieve()

Specified by:

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

Overrides:

processAfterRetrieve in class org.kuali.rice.krad.document.DocumentBase

validateBusinessRules

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

Override to provide more meaningful error message

Specified by:

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

Overrides:

validateBusinessRules in class org.kuali.rice.krad.document.DocumentBase

Parameters:

event -

updateDocumentDescriptions

public void updateDocumentDescriptions(List<BudgetDocumentVersion> budgetVersionOverviews)

getCustomAttributeDocuments

public Map<String,CustomAttributeDocument> getCustomAttributeDocuments()

This method populates the customAttributes for this document.

getDocumentCustomData

public abstract List<? extends DocumentCustomData> getDocumentCustomData()

getUpdateTimestamp

public Timestamp getUpdateTimestamp()

setUpdateTimestamp

public void setUpdateTimestamp(Timestamp updateTimestamp)

getUpdateUser

public String getUpdateUser()

setUpdateUser

public void setUpdateUser(String updateUser)

setDocumentNextvalues

public void setDocumentNextvalues(List<DocumentNextvalue> documentNextvalues)

getDocumentNextvalues

public List<DocumentNextvalue> getDocumentNextvalues()

getDocumentNextValue

public Integer getDocumentNextValue(String propertyName)

getDocumentNextvalueBo

public DocumentNextvalue getDocumentNextvalueBo(String propertyName)

setCustomAttributeDocuments

public void setCustomAttributeDocuments(Map<String,CustomAttributeDocument> customAttributeDocuments)

Sets the customAttributeDocuments attribute value.

Parameters:

customAttributeDocuments - The customAttributeDocuments to set.

getCustomAttributeDocument

public CustomAttributeDocument getCustomAttributeDocument(String key)

Gets the customAttributeDocuments attribute.

Returns:

Returns the customAttributeDocuments.

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

Overrides:

wrapDocumentWithMetadataForXmlSerialization in class org.kuali.rice.krad.document.DocumentBase

See Also:

Document.wrapDocumentWithMetadataForXmlSerialization()

getAllRolePersons

protected List<RolePersons> getAllRolePersons()

Get the list of roles for the document along with each of the individuals in those roles. This information will be serialized into XML for workflow routing purposes. It is expected that this method will be overridden by derived classes.

Returns:

the list of roles and the users in those roles for this document

getService

protected <T> T getService(Class<T> serviceClass)

Lookups and returns a service class. This method can be overriden for easier unit testing.

Type Parameters:

T - the type of service.

Parameters:

serviceClass - the service class.

Returns:

the service.

getDocumentTypeCode

public abstract String getDocumentTypeCode()

isViewOnly

public boolean isViewOnly()

setViewOnly

public void setViewOnly(boolean viewOnly)

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String routeNodeName)
                                throws Exception

In documents that support it, this method should answer T/F for a SplitNode question regarding routing. The SimpleBooleanSplitNode will supply the route node name which implementations should use to answer the question. For example, isHierarchyChild would be answered by ProposalDevelopementDocument as T if the document is a child within a proposal hierarchy and false otherwise. If a document does not support answering the question, it should throw an UnsupportedOperationException. The stub implementation throws an UnsupportedOperationException for any input.

Parameters:

routeNodeName - The name of the routeNode as it appears in the document workflow definition.

Returns:

boolean value representing the answer.

Throws:

UnsupportedOperationException - if the document does not support answering a split node question, or if it does not support answering the question for the supplied route name.

Exception

populateAdditionalQualifiedRoleAttributes

public void populateAdditionalQualifiedRoleAttributes(Map<String,String> qualifiedRoleAttributes)

toCopy

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

Overrides:

toCopy in class org.kuali.rice.krad.document.DocumentBase

Throws:

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

IllegalStateException

isProcessComplete

public abstract boolean isProcessComplete()

Returns whether the post-processing is considered complete for this document.

Returns:

true if the post-processing is complete, false otherwise