org.kuali.kra.protocol

Class ProtocolDaoOjbBase<GenericProtocol extends ProtocolBase>

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

org.kuali.kra.protocol.ProtocolDaoOjbBase<GenericProtocol>

All Implemented Interfaces:

ProtocolDao<GenericProtocol>, org.kuali.rice.core.framework.persistence.dao.PlatformAwareDao, org.kuali.rice.krad.util.OjbCollectionAware, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

IacucProtocolDaoOjb

public abstract class ProtocolDaoOjbBase<GenericProtocol extends ProtocolBase>
extends org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb
implements org.kuali.rice.krad.util.OjbCollectionAware, ProtocolDao<GenericProtocol>

This class is the implementation for ProtocolDao interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	collectionFieldNames

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor and Description
ProtocolDaoOjbBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Collection<String>	getActiveProtocolStatusCodesHook()
protected abstract Collection<String>	getApprovedSubmissionStatusCodesHook()
protected org.apache.ojb.broker.query.ReportQueryByCriteria	getCollectionReportQuery(String key, CriteriaFieldHelper critField)
protected abstract List<CriteriaFieldHelper>	getCriteriaFields()
List<GenericProtocol>	getExpiringProtocols(String committeeId, Date startDate, Date endDate) This method returns all Protocols that were approved by the specified committee and expires in the specified date range.
List<ProtocolBase>	getNotifiedProtocols(String committeeId, Date startDate, Date endDate) This method returns all Protocols that were given a decision status of "Specify Minor Revision" (SMR) or "Substantive Revision Required" (SRR) by the specified committee in the specified date range.
protected abstract Collection<String>	getPendingAmendmentRenewalsProtocolStatusCodesHook()
protected abstract Class<? extends ProtocolActionBase>	getProtocolActionBOClassHoook()
protected abstract Class<? extends ProtocolBase>	getProtocolBOClassHook()
protected abstract Class<? extends ProtocolPersonBase>	getProtocolPersonBOClassHook()
List<GenericProtocol>	getProtocols(Map<String,String> fieldValues) This method get protocols lookup search results.
protected abstract Class<? extends ProtocolSubmissionBase>	getProtocolSubmissionBOClassHook()
boolean	getProtocolSubmissionCountFromProtocol(String protocolNumber) select count(b.protocol_number) into li_SubmissionCount from osp$protocol b where b.protocol_number like as_protocol_number || '%' and b.sequence_number = (select max(a.sequence_number) from osp$protocol a where a.protocol_number = b.protocol_number) and b.protocol_status_code in (100, 101, 102, 103, 104, 105, 106); Replaced above query with following query by removing sub-query and added java code to to get sub-query behaviour.
protected abstract Class<? extends ProtocolUnitBase>	getProtocolUnitBOClassHook()
protected abstract Collection<String>	getRevisionRequestedProtocolActionTypeCodesHook()
protected abstract Collection<String>	getRevisionRequestedProtocolStatusCodesHook()
protected void	initCollectionFields()
protected abstract void	initRoleListsHook(List<String> investigatorRoles, List<String> personRoles)
<T extends ProtocolAttachmentBase & TypedAttachment> List<T>	retrieveAttachmentVersions(T attachment, Class<T> type) Gets all the attachment versions based on the passed in attachment.
void	setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService)
void	setLookupDao(org.kuali.rice.krad.dao.LookupDao lookupDao)

Methods inherited from class org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

getDbPlatform, setDbPlatform

Methods inherited from class org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

checkDaoConfig, convertOjbAccessException, createPersistenceBrokerTemplate, getJcdAlias, getPersistenceBroker, getPersistenceBrokerTemplate, releasePersistenceBroker, setJcdAlias, setPersistenceBrokerTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.util.OjbCollectionAware

getPersistenceBrokerTemplate

Field Detail

collectionFieldNames

protected List<String> collectionFieldNames

Constructor Detail

ProtocolDaoOjbBase

public ProtocolDaoOjbBase()

Method Detail

getProtocols

public List<GenericProtocol> getProtocols(Map<String,String> fieldValues)

Description copied from interface: ProtocolDao

This method get protocols lookup search results.

Specified by:

getProtocols in interface ProtocolDao<GenericProtocol extends ProtocolBase>

Returns:

See Also:

ProtocolDao.getProtocols(java.util.Map)

retrieveAttachmentVersions

public <T extends ProtocolAttachmentBase & TypedAttachment> List<T> retrieveAttachmentVersions(T attachment,
                                                                                     Class<T> type)

Gets all the attachment versions based on the passed in attachment. This will include the pass-in attachment.

Specified by:

retrieveAttachmentVersions in interface ProtocolDao<GenericProtocol extends ProtocolBase>

Parameters:

attachment - the attachment to base the query off of

type - a class token used for retrieving the attachments

Returns:

the list of attachments, empty list if none to return or the attachment is invalid for a lookup

getExpiringProtocols

public List<GenericProtocol> getExpiringProtocols(String committeeId,
                                         Date startDate,
                                         Date endDate)

This method returns all Protocols that were approved by the specified committee and expires in the specified date range.

Specified by:

getExpiringProtocols in interface ProtocolDao<GenericProtocol extends ProtocolBase>

Parameters:

committeeId - of the most recent protocol submission that approved the protocol.

startDate - of the date range for the expiration date of the protocol. The start date is optional. If no start date is specified, the beginning of time will be used.

endDate - of the date range for the expiration date of the protocol. The end date is optional. If no end date is specified, the end of time will be used.

Returns:

List of the requested Protocols

getApprovedSubmissionStatusCodesHook

protected abstract Collection<String> getApprovedSubmissionStatusCodesHook()

getActiveProtocolStatusCodesHook

protected abstract Collection<String> getActiveProtocolStatusCodesHook()

getNotifiedProtocols

public List<ProtocolBase> getNotifiedProtocols(String committeeId,
                                      Date startDate,
                                      Date endDate)

Description copied from interface: ProtocolDao

This method returns all Protocols that were given a decision status of "Specify Minor Revision" (SMR) or "Substantive Revision Required" (SRR) by the specified committee in the specified date range.

Specified by:

getNotifiedProtocols in interface ProtocolDao<GenericProtocol extends ProtocolBase>

Parameters:

committeeId - of the

endDate - of the date range for the

Returns:

List of the requested Protocols

getRevisionRequestedProtocolActionTypeCodesHook

protected abstract Collection<String> getRevisionRequestedProtocolActionTypeCodesHook()

getRevisionRequestedProtocolStatusCodesHook

protected abstract Collection<String> getRevisionRequestedProtocolStatusCodesHook()

getProtocolActionBOClassHoook

protected abstract Class<? extends ProtocolActionBase> getProtocolActionBOClassHoook()

initCollectionFields

protected void initCollectionFields()

initRoleListsHook

protected abstract void initRoleListsHook(List<String> investigatorRoles,
                     List<String> personRoles)

getCollectionReportQuery

protected org.apache.ojb.broker.query.ReportQueryByCriteria getCollectionReportQuery(String key,
                                                                         CriteriaFieldHelper critField)

setLookupDao

public void setLookupDao(org.kuali.rice.krad.dao.LookupDao lookupDao)

setDataDictionaryService

public void setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService)

getProtocolSubmissionCountFromProtocol

public boolean getProtocolSubmissionCountFromProtocol(String protocolNumber)

select count(b.protocol_number) into li_SubmissionCount from osp$protocol b where b.protocol_number like as_protocol_number || '%' and b.sequence_number = (select max(a.sequence_number) from osp$protocol a where a.protocol_number = b.protocol_number) and b.protocol_status_code in (100, 101, 102, 103, 104, 105, 106); Replaced above query with following query by removing sub-query and added java code to to get sub-query behaviour. select (b.protocol_number) from protocol b where b.protocol_number like '001%' and b.protocol_status_code in (100, 101, 102, 103, 104, 105, 106);

Specified by:

getProtocolSubmissionCountFromProtocol in interface ProtocolDao<GenericProtocol extends ProtocolBase>

Returns:

See Also:

org.kuali.kra.protocol.ProtocolDao#getProtocolSubmissionCount(java.lang.String)

getPendingAmendmentRenewalsProtocolStatusCodesHook

protected abstract Collection<String> getPendingAmendmentRenewalsProtocolStatusCodesHook()

getProtocolBOClassHook

protected abstract Class<? extends ProtocolBase> getProtocolBOClassHook()

getProtocolPersonBOClassHook

protected abstract Class<? extends ProtocolPersonBase> getProtocolPersonBOClassHook()

getProtocolUnitBOClassHook

protected abstract Class<? extends ProtocolUnitBase> getProtocolUnitBOClassHook()

getProtocolSubmissionBOClassHook

protected abstract Class<? extends ProtocolSubmissionBase> getProtocolSubmissionBOClassHook()

getCriteriaFields

protected abstract List<CriteriaFieldHelper> getCriteriaFields()