org.kuali.kra.irb

Class ProtocolDocument

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.ProtocolDocumentBase

org.kuali.kra.irb.ProtocolDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, KrmsRulesContext, 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

public class ProtocolDocument
extends ProtocolDocumentBase

This class represents the Protocol Document Object. ProtocolDocument has a 1:1 relationship with Protocol Business Object. We have declared a list of Protocol BOs in the ProtocolDocument 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; Protocol and ProtocolDocument can have a 1:1 relationship.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.kra.protocol.ProtocolDocumentBase

ProtocolDocumentBase.ProtocolMergeException, ProtocolDocumentBase.ProtocolWorkflowType

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_TYPE_CODE

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addFacts(org.kuali.rice.krms.api.engine.Facts.Builder factsBuilder)
protected Protocol	createNewProtocolInstanceHook()
protected String	getCommitteeDisapprovedStatusCodeHook()
List<CustomAttributeDocValue>	getCustomDataList()
protected ProtocolNotificationContextBase	getDisapproveNotificationContextHook(ProtocolBase protocol)
List<? extends DocumentCustomData>	getDocumentCustomData()
String	getDocumentTypeCode()
protected ProtocolActionBase	getNewProtocolActionInstanceHook(ProtocolBase protocol, ProtocolSubmissionBase protocolSubmission, String actionTypeCode)
protected ProtocolNotification	getNewProtocolNotificationInstanceHook()
Protocol	getProtocol() This method is a convenience method for facilitating a 1:1 relationship between ProtocolDocument and Protocol to the outside world - aka a single Protocol field associated with ProtocolDocument
protected Class<? extends ProtocolActionService>	getProtocolActionServiceClassHook()
protected Class<? extends ProtocolBase>	getProtocolBOClassHook()
protected Class<? extends ProtocolGenericActionService>	getProtocolGenericActionServiceClassHook()
protected Class<? extends ProtocolLocationService>	getProtocolLocationServiceClassHook()
protected Class<? extends ProtocolResearchAreaService>	getProtocolResearchAreaServiceClassHook()
protected Class<? extends ResearchAreaBase>	getResearchAreaBoClassHook()
boolean	isProcessComplete() This method is to check whether rice async routing is ok now.
protected void	mergeAmendment(String protocolStatusCode, String type) Merge the amendment into the original protocol.
protected void	mergeProtocolAmendment()
protected void	mergeProtocolCorrespondenceAndNotification(ProtocolDocument newProtocolDocument, String protocolActionType)
void	populateContextQualifiers(Map<String,String> qualifiers)
void	setCustomDataList(List<CustomAttributeDocValue> customDataList)

Methods inherited from class org.kuali.kra.protocol.ProtocolDocumentBase

buildListOfDeletionAwareLists, doRouteStatusChange, finalizeAttachmentProtocol, getAllRolePersons, getBusinessObjectService, getCustomLockDescriptor, getDocumentService, getLatestCurrentActionTakenValue, getNewProtocolDocId, getNotificationService, getOriginalProtocolNumber, getProtocolActionService, getProtocolGenericActionService, getProtocolList, getProtocolNumberIndex, getProtocolWorkflowType, getReRouted, getRouteHeaderService, getWorkflowDocumentService, initialize, isAmendment, isDisapproved, isFinal, isNormal, isRecall, isRenewal, performVersioningOperationsOnProtocolAfterDisapproval, populateAgendaQualifiers, prepareForSave, setProtocol, setProtocolList, setProtocolWorkflowType, setReRouted, updateProtocolStatus, useCustomLockDescriptors, wrapDocumentWithMetadataForXmlSerialization

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

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

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, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, 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

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

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, 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, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

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

DOCUMENT_TYPE_CODE

public static final String DOCUMENT_TYPE_CODE

See Also:

Constant Field Values

Constructor Detail

ProtocolDocument

public ProtocolDocument()

Method Detail

getProtocol

public Protocol getProtocol()

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

Overrides:

getProtocol in class ProtocolDocumentBase

Returns:

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ProtocolDocumentBase

mergeProtocolAmendment

protected void mergeProtocolAmendment()

Specified by:

mergeProtocolAmendment in class ProtocolDocumentBase

mergeAmendment

protected void mergeAmendment(String protocolStatusCode,
                  String type)

Merge the amendment into the original protocol. Actually, we must first make a new version of the original and then merge the amendment into that new version. Also merge changes into any versions of the protocol that are being amended/renewed.

Parameters:

protocolStatusCode -

Throws:

Exception

mergeProtocolCorrespondenceAndNotification

protected void mergeProtocolCorrespondenceAndNotification(ProtocolDocument newProtocolDocument,
                                              String protocolActionType)

isProcessComplete

public boolean isProcessComplete()

This method is to check whether rice async routing is ok now. Close to hack. called by holdingpageaction Different document type may have different routing set up, so each document type can implement its own isProcessComplete

Specified by:

isProcessComplete in class ResearchDocumentBase

Returns:

Throws:

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

populateContextQualifiers

public void populateContextQualifiers(Map<String,String> qualifiers)

addFacts

public void addFacts(org.kuali.rice.krms.api.engine.Facts.Builder factsBuilder)

createNewProtocolInstanceHook

protected Protocol createNewProtocolInstanceHook()

Specified by:

createNewProtocolInstanceHook in class ProtocolDocumentBase

getProtocolResearchAreaServiceClassHook

protected Class<? extends ProtocolResearchAreaService> getProtocolResearchAreaServiceClassHook()

Specified by:

getProtocolResearchAreaServiceClassHook in class ProtocolDocumentBase

getResearchAreaBoClassHook

protected Class<? extends ResearchAreaBase> getResearchAreaBoClassHook()

Specified by:

getResearchAreaBoClassHook in class ProtocolDocumentBase

getNewProtocolActionInstanceHook

protected ProtocolActionBase getNewProtocolActionInstanceHook(ProtocolBase protocol,
                                                  ProtocolSubmissionBase protocolSubmission,
                                                  String actionTypeCode)

Specified by:

getNewProtocolActionInstanceHook in class ProtocolDocumentBase

getProtocolActionServiceClassHook

protected Class<? extends ProtocolActionService> getProtocolActionServiceClassHook()

Specified by:

getProtocolActionServiceClassHook in class ProtocolDocumentBase

getProtocolLocationServiceClassHook

protected Class<? extends ProtocolLocationService> getProtocolLocationServiceClassHook()

Specified by:

getProtocolLocationServiceClassHook in class ProtocolDocumentBase

getProtocolBOClassHook

protected Class<? extends ProtocolBase> getProtocolBOClassHook()

Specified by:

getProtocolBOClassHook in class ProtocolDocumentBase

getDocumentCustomData

public List<? extends DocumentCustomData> getDocumentCustomData()

Specified by:

getDocumentCustomData in class ResearchDocumentBase

getCustomDataList

public List<CustomAttributeDocValue> getCustomDataList()

setCustomDataList

public void setCustomDataList(List<CustomAttributeDocValue> customDataList)

getProtocolGenericActionServiceClassHook

protected Class<? extends ProtocolGenericActionService> getProtocolGenericActionServiceClassHook()

Specified by:

getProtocolGenericActionServiceClassHook in class ProtocolDocumentBase

getNewProtocolNotificationInstanceHook

protected ProtocolNotification getNewProtocolNotificationInstanceHook()

Specified by:

getNewProtocolNotificationInstanceHook in class ProtocolDocumentBase

getDisapproveNotificationContextHook

protected ProtocolNotificationContextBase getDisapproveNotificationContextHook(ProtocolBase protocol)

Specified by:

getDisapproveNotificationContextHook in class ProtocolDocumentBase

getCommitteeDisapprovedStatusCodeHook

protected String getCommitteeDisapprovedStatusCodeHook()

Specified by:

getCommitteeDisapprovedStatusCodeHook in class ProtocolDocumentBase