org.kuali.kra.protocol

Class ProtocolDocumentBase

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

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

Direct Known Subclasses:

IacucProtocolDocument, ProtocolDocument

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolDocumentBase.ProtocolMergeException
static class	ProtocolDocumentBase.ProtocolWorkflowType Contains all the property names in this class.

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

Method Summary

Methods

Modifier and Type	Method and Description
List	buildListOfDeletionAwareLists()
protected abstract ProtocolBase	createNewProtocolInstanceHook()
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
protected void	finalizeAttachmentProtocol(ProtocolBase protocol)
protected List<RolePersons>	getAllRolePersons() Get the list of roles for the document along with each of the individuals in those roles.
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected abstract String	getCommitteeDisapprovedStatusCodeHook()
String	getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)
protected abstract ProtocolNotificationContextBase	getDisapproveNotificationContextHook(ProtocolBase protocol)
protected org.kuali.rice.krad.service.DocumentService	getDocumentService()
abstract String	getDocumentTypeCode()
protected org.kuali.rice.kew.actiontaken.ActionTakenValue	getLatestCurrentActionTakenValue()
protected abstract ProtocolActionBase	getNewProtocolActionInstanceHook(ProtocolBase protocol, ProtocolSubmissionBase protocolSubmission, String actionTypeCode)
protected String	getNewProtocolDocId() This method returns the doc number of the current active protocol
protected abstract ProtocolNotification	getNewProtocolNotificationInstanceHook()
protected KcNotificationService	getNotificationService()
protected String	getOriginalProtocolNumber() Amendments/Renewals have a protocol number with a 4 character suffix.
ProtocolBase	getProtocol() 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
protected ProtocolActionService	getProtocolActionService()
protected abstract Class<? extends ProtocolActionService>	getProtocolActionServiceClassHook()
protected abstract Class<? extends ProtocolBase>	getProtocolBOClassHook()
protected ProtocolGenericActionService	getProtocolGenericActionService()
protected abstract Class<? extends ProtocolGenericActionService>	getProtocolGenericActionServiceClassHook()
List<ProtocolBase>	getProtocolList() This method is used by OJB to get around with anonymous keys issue.
protected abstract Class<? extends ProtocolLocationService>	getProtocolLocationServiceClassHook()
protected String	getProtocolNumberIndex()
protected abstract Class<? extends ProtocolResearchAreaService>	getProtocolResearchAreaServiceClassHook()
String	getProtocolWorkflowType()
boolean	getReRouted()
protected abstract Class<? extends ResearchAreaBase>	getResearchAreaBoClassHook()
protected org.kuali.rice.kew.routeheader.service.RouteHeaderService	getRouteHeaderService()
protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService	getWorkflowDocumentService()
void	initialize()
boolean	isAmendment() Is this an amendment protocol document?
protected boolean	isDisapproved(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) Has the document entered the disapproval state in workflow?
protected boolean	isFinal(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) Has the document entered the final state in workflow?
boolean	isNormal() Is this a normal protocol document?
protected boolean	isRecall(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
boolean	isRenewal() Is this a renewal protocol document?
protected abstract void	mergeProtocolAmendment()
protected void	performVersioningOperationsOnProtocolAfterDisapproval()
void	populateAgendaQualifiers(Map<String,String> qualifiers)
void	prepareForSave()
void	setProtocol(ProtocolBase protocol) 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	setProtocolList(List<ProtocolBase> protocolList) This method is used by OJB to get around with anonymous keys issue.
void	setProtocolWorkflowType(ProtocolDocumentBase.ProtocolWorkflowType protocolWorkflowType)
void	setReRouted(boolean reRouted)
void	updateProtocolStatus(String actionTypeCode, String comments) Add a new protocol action to the protocol and update the status.
boolean	useCustomLockDescriptors()
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.kra.document.ResearchDocumentBase

answerSplitNodeQuestion, getCustomAttributeDocument, getCustomAttributeDocuments, getDocumentCustomData, getDocumentNextValue, getDocumentNextvalueBo, getDocumentNextvalues, getService, getUpdateTimestamp, getUpdateUser, isProcessComplete, 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.kra.krms.KrmsRulesContext

addFacts, populateContextQualifiers

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

Constructor Detail

ProtocolDocumentBase

public ProtocolDocumentBase()

Constructs a ProtocolDocumentBase object.

Method Detail

createNewProtocolInstanceHook

protected abstract ProtocolBase createNewProtocolInstanceHook()

initialize

public void initialize()

Overrides:

initialize in class ResearchDocumentBase

See Also:

ResearchDocumentBase.initialize()

getProtocolResearchAreaServiceClassHook

protected abstract Class<? extends ProtocolResearchAreaService> getProtocolResearchAreaServiceClassHook()

getResearchAreaBoClassHook

protected abstract Class<? extends ResearchAreaBase> getResearchAreaBoClassHook()

getProtocol

public ProtocolBase getProtocol()

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:

setProtocol

public void setProtocol(ProtocolBase protocol)

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 -

getProtocolList

public List<ProtocolBase> getProtocolList()

This method is used by OJB to get around with anonymous keys issue. Warning : Developers should never use this method.

Returns:

List

setProtocolList

public void setProtocolList(List<ProtocolBase> protocolList)

This method is used by OJB to get around with anonymous keys issue. Warning : Developers should never use this method

Parameters:

protocolList -

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

See Also:

org.kuali.core.bo.PersistableBusinessObjectBase#buildListOfDeletionAwareLists()

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 abstract String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

getProtocolWorkflowType

public String getProtocolWorkflowType()

setProtocolWorkflowType

public void setProtocolWorkflowType(ProtocolDocumentBase.ProtocolWorkflowType protocolWorkflowType)

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)

performVersioningOperationsOnProtocolAfterDisapproval

protected void performVersioningOperationsOnProtocolAfterDisapproval()
                                                              throws Exception

Throws:

Exception

getCommitteeDisapprovedStatusCodeHook

protected abstract String getCommitteeDisapprovedStatusCodeHook()

getNewProtocolNotificationInstanceHook

protected abstract ProtocolNotification getNewProtocolNotificationInstanceHook()

getDisapproveNotificationContextHook

protected abstract ProtocolNotificationContextBase getDisapproveNotificationContextHook(ProtocolBase protocol)

getLatestCurrentActionTakenValue

protected final org.kuali.rice.kew.actiontaken.ActionTakenValue getLatestCurrentActionTakenValue()

getRouteHeaderService

protected org.kuali.rice.kew.routeheader.service.RouteHeaderService getRouteHeaderService()

getNotificationService

protected KcNotificationService getNotificationService()

getProtocolGenericActionService

protected ProtocolGenericActionService getProtocolGenericActionService()

getProtocolGenericActionServiceClassHook

protected abstract Class<? extends ProtocolGenericActionService> getProtocolGenericActionServiceClassHook()

mergeProtocolAmendment

protected abstract void mergeProtocolAmendment()

updateProtocolStatus

public void updateProtocolStatus(String actionTypeCode,
                        String comments)

Add a new protocol action to the protocol and update the status.

Parameters:

actionTypeCode - the new action

getNewProtocolActionInstanceHook

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

getProtocolActionService

protected ProtocolActionService getProtocolActionService()

getProtocolActionServiceClassHook

protected abstract Class<? extends ProtocolActionService> getProtocolActionServiceClassHook()

finalizeAttachmentProtocol

protected void finalizeAttachmentProtocol(ProtocolBase protocol)

getProtocolNumberIndex

protected String getProtocolNumberIndex()

getDocumentService

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

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

getOriginalProtocolNumber

protected String getOriginalProtocolNumber()

Amendments/Renewals have a protocol number with a 4 character suffix. The first 10 characters is the protocol number of the original protocol.

Returns:

isFinal

protected boolean isFinal(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

Has the document entered the final state in workflow?

Parameters:

statusChangeEvent -

Returns:

isDisapproved

protected boolean isDisapproved(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

Has the document entered the disapproval state in workflow?

Parameters:

statusChangeEvent -

Returns:

isRecall

protected boolean isRecall(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

isRenewal

public boolean isRenewal()

Is this a renewal protocol document?

Returns:

isAmendment

public boolean isAmendment()

Is this an amendment protocol document?

Returns:

isNormal

public boolean isNormal()

Is this a normal protocol document?

Returns:

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class ResearchDocumentBase

getProtocolLocationServiceClassHook

protected abstract Class<? extends ProtocolLocationService> getProtocolLocationServiceClassHook()

wrapDocumentWithMetadataForXmlSerialization

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

Description copied from class: ResearchDocumentBase

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 ResearchDocumentBase

See Also:

Document.wrapDocumentWithMetadataForXmlSerialization()

useCustomLockDescriptors

public boolean useCustomLockDescriptors()

Specified by:

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

Overrides:

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

getCustomLockDescriptor

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

Specified by:

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

Overrides:

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

getReRouted

public boolean getReRouted()

setReRouted

public void setReRouted(boolean reRouted)

getWorkflowDocumentService

protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService getWorkflowDocumentService()

getNewProtocolDocId

protected String getNewProtocolDocId()

This method returns the doc number of the current active protocol

Returns:

documentNumber

getProtocolBOClassHook

protected abstract Class<? extends ProtocolBase> getProtocolBOClassHook()

populateAgendaQualifiers

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

Specified by:

populateAgendaQualifiers in interface KrmsRulesContext