org.kuali.kra.protocol

Class ProtocolOnlineReviewDocumentBase

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

org.kuali.kra.protocol.ProtocolOnlineReviewDocumentBase

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.Copyable, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

IacucProtocolOnlineReviewDocument, ProtocolOnlineReviewDocument

public abstract class ProtocolOnlineReviewDocumentBase
extends ResearchDocumentBase
implements org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.SessionDocument

This class represents the ProtocolBase Review Document Object. ProtocolReviewDocument has a 1:1 relationship with ProtocolReview Business Object. We have declared a list of ProtocolBase BOs in the ProtocolDocumentBase at the same time to get around the OJB anonymous keys issue of primary keys of different data types. Also we have provided convenient getter and setter methods so that to the outside world; ProtocolBase and ProtocolDocumentBase can have a 1:1 relationship.

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
ProtocolOnlineReviewDocumentBase() Constructs a ProtocolDocumentBase object

Method Summary

Methods

Modifier and Type	Method and Description
void	doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
protected List<RolePersons>	getAllRolePersons() Get the list of roles for the document along with each of the individuals in those roles.
String	getDocumentTypeCode()
abstract ProtocolOnlineReviewBase	getProtocolOnlineReview() This method is a convenience method for facilitating a 1:1 relationship between ProtocolDocumentBase and ProtocolBase to the outside world - aka a single ProtocolBase field associated with ProtocolDocumentBase
void	initialize()
boolean	isProcessComplete() Returns whether the post-processing is considered complete for this document.
void	prepareForSave()
abstract void	setProtocolOnlineReview(ProtocolOnlineReviewBase protocolOnlineReview) This method is a convenience method for facilitating a 1:1 relationship between ProtocolDocumentBase and ProtocolBase to the outside world - aka a single ProtocolBase field associated with ProtocolDocumentBase

Methods inherited from class org.kuali.kra.document.ResearchDocumentBase

answerSplitNodeQuestion, getCustomAttributeDocument, getCustomAttributeDocuments, getDocumentCustomData, getDocumentNextValue, getDocumentNextvalueBo, getDocumentNextvalues, getService, getUpdateTimestamp, getUpdateUser, isViewOnly, populateAdditionalQualifiedRoleAttributes, processAfterRetrieve, setCustomAttributeDocuments, setDocumentNextvalues, setUpdateTimestamp, setUpdateUser, setViewOnly, toCopy, updateDocumentDescriptions, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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, doRouteLevelChange, 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.Copyable

toCopy

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doRouteLevelChange, 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

ProtocolOnlineReviewDocumentBase

public ProtocolOnlineReviewDocumentBase()

Constructs a ProtocolDocumentBase object

Method Detail

initialize

public void initialize()

Overrides:

initialize in class ResearchDocumentBase

getProtocolOnlineReview

public abstract ProtocolOnlineReviewBase getProtocolOnlineReview()

This method is a convenience method for facilitating a 1:1 relationship between ProtocolDocumentBase and ProtocolBase to the outside world - aka a single ProtocolBase field associated with ProtocolDocumentBase

Returns:

setProtocolOnlineReview

public abstract void setProtocolOnlineReview(ProtocolOnlineReviewBase protocolOnlineReview)

This method is a convenience method for facilitating a 1:1 relationship between ProtocolDocumentBase and ProtocolBase to the outside world - aka a single ProtocolBase field associated with ProtocolDocumentBase

Parameters:

protocol -

getAllRolePersons

protected List<RolePersons> getAllRolePersons()

Description copied from class: ResearchDocumentBase

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.

Overrides:

getAllRolePersons in class ResearchDocumentBase

Returns:

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

See Also:

ResearchDocumentBase.getAllRolePersons()

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

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

See Also:

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

doActionTaken

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

Specified by:

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

Overrides:

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

See Also:

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

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class ResearchDocumentBase

isProcessComplete

public boolean isProcessComplete()

Description copied from class: ResearchDocumentBase

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

Specified by:

isProcessComplete in class ResearchDocumentBase

Returns:

true if the post-processing is complete, false otherwise