org.kuali.kra.irb.actions.submit

Class ProtocolSubmitActionServiceImpl

java.lang.Object

org.kuali.kra.irb.actions.submit.ProtocolSubmitActionServiceImpl

All Implemented Interfaces:

ProtocolSubmitActionService

public class ProtocolSubmitActionServiceImpl
extends Object
implements ProtocolSubmitActionService

Handles the processing of submitting a protocol to the IRB office for review.

Constructor Summary

Constructors

Constructor and Description
ProtocolSubmitActionServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addActionToOriginalProtocol(String type, String origProtocolNumber, Integer submissionNumber) When an amendment/renewal is submitted to the IRB office, a corresponding action entry must be added to the original protocol so that the user will know when the amendment/renewal was submitted.
protected void	addCheckLists(ProtocolSubmissionBuilder submissionBuilder, ProtocolSubmitAction submitAction) Add an optional Check List to the submission.
protected void	addExemptStudiesCheckList(ProtocolSubmissionBuilder submissionBuilder, ProtocolSubmitAction submitAction) Add the Exempt Studies Check List items to the submission.
protected void	addExpeditedReviewCheckList(ProtocolSubmissionBuilder submissionBuilder, ProtocolSubmitAction action) Add the Expedited Review Check List items to the submission.
protected ProtocolSubmission	createProtocolSubmission(Protocol protocol, ProtocolSubmitAction submitAction) Create a Protocol Submission.
List<ProtocolSubmission>	getProtocolSubmissions(String protocolNumber) Finds all submissions for the given protocolNumber.
List<ProtocolSubmission>	getProtocolSubmissions(String protocolNumber, int submissionNumber) Finds all submissions for the given protocolNumber and submissionNumber.
List<ProtocolSubmission>	getProtocolSubmissionsLookupData(List<ProtocolSubmission> protocolSubmissionList) This method for getting ProtocolSubmissionsLookup from given protocolNumber...
int	getTotalSubmissions(Protocol protocol) Finds all submissions for the given protocolNumber and calculates how many total submissions it has overall.
protected boolean	isProtocolReviewType(ProtocolSubmitAction submitAction, String protocolReviewTypeCode) Is the submission of a certain protocol review type?
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Set the Business Object Service.
protected void	setCommittee(ProtocolSubmissionBuilder submissionBuilder, ProtocolSubmitAction submitAction) Set committee for the submission.
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) Set the Document Service.
void	setProtocolActionService(ProtocolActionService protocolActionService) Set the Protocol Action Service.
void	setProtocolAssignReviewersService(ProtocolAssignReviewersService protocolAssignReviewersService) Set the Protocol Assign Reviewers Service.
void	setProtocolFinderDao(ProtocolFinderDao protocolFinderDao) Set the Protocol Finder DAO.
protected void	setSchedule(ProtocolSubmissionBuilder submissionBuilder, ProtocolSubmitAction submitAction) Set schedule for the submission.
protected void	setSubmissionStatus(ProtocolSubmissionBuilder submissionBuilder, ProtocolSubmitAction submitAction) Set the submission status.
void	submitToIrbForReview(Protocol protocol, ProtocolSubmitAction submitAction) When a protocol is submitted for review, an action entry must be added to the protocol.
protected void	updateDefaultSchedule(ProtocolSubmission submission)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolSubmitActionServiceImpl

public ProtocolSubmitActionServiceImpl()

Method Detail

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

Set the Document Service.

Parameters:

documentService -

setProtocolActionService

public void setProtocolActionService(ProtocolActionService protocolActionService)

Set the Protocol Action Service.

Parameters:

protocolActionService -

setProtocolFinderDao

public void setProtocolFinderDao(ProtocolFinderDao protocolFinderDao)

Set the Protocol Finder DAO.

Parameters:

protocolFinderDao -

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

Set the Business Object Service.

Parameters:

businessObjectService -

setProtocolAssignReviewersService

public void setProtocolAssignReviewersService(ProtocolAssignReviewersService protocolAssignReviewersService)

Set the Protocol Assign Reviewers Service.

Parameters:

protocolAssignReviewersService -

getTotalSubmissions

public int getTotalSubmissions(Protocol protocol)

Finds all submissions for the given protocolNumber and calculates how many total submissions it has overall.

Specified by:

getTotalSubmissions in interface ProtocolSubmitActionService

Parameters:

protocol - protocol

Returns:

the total number of submissions for the given protocolNumber

See Also:

org.kuali.kra.irb.actions.submit.ProtocolSubmitActionService#getTotalSubmissions(java.lang.String)

getProtocolSubmissions

public List<ProtocolSubmission> getProtocolSubmissions(String protocolNumber)

Finds all submissions for the given protocolNumber.

Specified by:

getProtocolSubmissions in interface ProtocolSubmitActionService

Parameters:

protocolNumber - The human-readable protocol number

Returns:

the list of submissions for the given protocolNumber

See Also:

ProtocolSubmitActionService.getProtocolSubmissions(java.lang.String)

getProtocolSubmissions

public List<ProtocolSubmission> getProtocolSubmissions(String protocolNumber,
                                              int submissionNumber)

Finds all submissions for the given protocolNumber and submissionNumber. Note that there are multiple submissions for a given protocol since the submissions are copied when the protocol is versioned.

Specified by:

getProtocolSubmissions in interface ProtocolSubmitActionService

Parameters:

protocolNumber - The human-readable protocol number

submissionNumber - The submission number

Returns:

the list of submissions for the given protocolNumber

See Also:

org.kuali.kra.irb.actions.submit.ProtocolSubmitActionService#getProtocolSubmissions(java.lang.String, java.lang.String)

getProtocolSubmissionsLookupData

public List<ProtocolSubmission> getProtocolSubmissionsLookupData(List<ProtocolSubmission> protocolSubmissionList)
                                                          throws Exception

Description copied from interface: ProtocolSubmitActionService

This method for getting ProtocolSubmissionsLookup from given protocolNumber...

Specified by:

getProtocolSubmissionsLookupData in interface ProtocolSubmitActionService

Returns:

Throws:

Exception

See Also:

ProtocolSubmitActionService.getProtocolSubmissionsLookupData(java.util.List)

submitToIrbForReview

public void submitToIrbForReview(Protocol protocol,
                        ProtocolSubmitAction submitAction)
                          throws Exception

When a protocol is submitted for review, an action entry must be added to the protocol. This action entry is a history of the major events that have occurred during the life of the protocol. Also, for a submission, a Submission BO must be created. It contains all of the relevant data for a submission: type, checklists, reviewers, etc.

Specified by:

submitToIrbForReview in interface ProtocolSubmitActionService

Parameters:

protocol - the protocol

submitAction - the submission data

Throws:

Exception

See Also:

ProtocolSubmitActionService.submitToIrbForReview(org.kuali.kra.irb.Protocol, org.kuali.kra.irb.actions.submit.ProtocolSubmitAction)

updateDefaultSchedule

protected void updateDefaultSchedule(ProtocolSubmission submission)

addActionToOriginalProtocol

protected void addActionToOriginalProtocol(String type,
                               String origProtocolNumber,
                               Integer submissionNumber)
                                    throws org.kuali.rice.kew.api.exception.WorkflowException

When an amendment/renewal is submitted to the IRB office, a corresponding action entry must be added to the original protocol so that the user will know when the amendment/renewal was submitted.

Parameters:

type -

origProtocolNumber -

Throws:

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

Exception

createProtocolSubmission

protected ProtocolSubmission createProtocolSubmission(Protocol protocol,
                                          ProtocolSubmitAction submitAction)

Create a Protocol Submission.

Parameters:

protocol - the protocol

submitAction - the submission data

Returns:

a protocol submission

setSubmissionStatus

protected void setSubmissionStatus(ProtocolSubmissionBuilder submissionBuilder,
                       ProtocolSubmitAction submitAction)

Set the submission status.

Parameters:

submissionBuilder - the submission builder

submitAction - the submission data

setCommittee

protected void setCommittee(ProtocolSubmissionBuilder submissionBuilder,
                ProtocolSubmitAction submitAction)

Set committee for the submission.

Parameters:

submissionBuilder - the submission builder

submitAction - the submission data

setSchedule

protected void setSchedule(ProtocolSubmissionBuilder submissionBuilder,
               ProtocolSubmitAction submitAction)

Set schedule for the submission.

Parameters:

submissionBuilder - the submission builder

submitAction - the submission data

addCheckLists

protected void addCheckLists(ProtocolSubmissionBuilder submissionBuilder,
                 ProtocolSubmitAction submitAction)

Add an optional Check List to the submission. Exempt Studies and Expedited Reviews each require a check list to be added to the submission. Other protocol review types do not have a check list.

Parameters:

submission - the submission

submitAction - the submission data

isProtocolReviewType

protected boolean isProtocolReviewType(ProtocolSubmitAction submitAction,
                           String protocolReviewTypeCode)

Is the submission of a certain protocol review type?

Parameters:

submitAction - the submit action

protocolReviewTypeCode - the protocol review type to compare against

Returns:

true if the submission uses the given protocol review type; otherwise false

addExemptStudiesCheckList

protected void addExemptStudiesCheckList(ProtocolSubmissionBuilder submissionBuilder,
                             ProtocolSubmitAction submitAction)

Add the Exempt Studies Check List items to the submission.

Parameters:

submission - the submission

submitAction - the submission data

addExpeditedReviewCheckList

protected void addExpeditedReviewCheckList(ProtocolSubmissionBuilder submissionBuilder,
                               ProtocolSubmitAction action)

Add the Expedited Review Check List items to the submission.

Parameters:

submission - the submission

submitAction - the submission data