org.kuali.kra.protocol.onlinereview

Interface ProtocolOnlineReviewService

All Known Subinterfaces:

IacucProtocolOnlineReviewService, ProtocolOnlineReviewService

All Known Implementing Classes:

IacucProtocolOnlineReviewServiceImpl, ProtocolOnlineReviewServiceImpl, ProtocolOnlineReviewServiceImplBase

public interface ProtocolOnlineReviewService

ProtocolBase Online Review service provides all necessary functionality to manage the online reviews.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ONLINE_REVIEW_DOCUMENT_DESCRIPTION_FORMAT
static String	PROTOCOL_ONLINE_REVIEW_DOCUMENT_TYPE_CODE Document type code for online review.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelOnlineReviews(ProtocolSubmissionBase submission, String annotation) Cancels all online review documents associated with the submission.
ProtocolOnlineReviewDocumentBase	createAndRouteProtocolOnlineReviewDocument(ProtocolSubmissionBase protocolSubmission, ProtocolReviewer protocolReviewer, String documentDescription, String documentExplanation, String documentOrganizationDocumentNumber, String documentRouteAnnotation, boolean approveDocument, Date dateRequested, Date dateDue, String principalId) Assign an online review to a reviewer.
ProtocolReviewer	createProtocolReviewer(String principalId, boolean nonEmployeeFlag, String reviewerTypeCode, ProtocolSubmissionBase protocolSubmission) Creates a reviewer for the protocol included in the protocolSubmission.
void	finalizeOnlineReviews(ProtocolSubmissionBase submission, String annotation) Finalizes all online review documents associated with the submission.
List<CommitteeMembershipBase>	getAvailableCommitteeMembersForCurrentSubmission(ProtocolBase protocol) This method...
ProtocolOnlineReviewDocumentBase	getProtocolOnlineReviewDocument(String principalId, boolean nonEmployeeFlag, ProtocolSubmissionBase protocolSubmission) Returns the ProtocolOnlineReviewDocumentBase associated with the
String	getProtocolOnlineReviewDocumentDescription(String protocolNumber, String piName) Generate the standard document description for OLR documents.
List<ProtocolOnlineReviewDocumentBase>	getProtocolReviewDocumentsForCurrentSubmission(ProtocolBase protocol) Get a list of current ProtocolReview documents associated with the protocol and current submission.
ProtocolReviewer	getProtocolReviewer(String personId, boolean nonEmployeeFlag, ProtocolSubmissionBase protocolSubmission) Returns the online reviewer for the protocol submission corresponding to the principal id, if one exists.
List<ProtocolOnlineReviewBase>	getProtocolReviews(Long submissionId) This method returns a list of ProtocolOnlineReviewBase BOs that are associated with submission.
List<ProtocolOnlineReviewBase>	getProtocolReviews(String protocolNumber) Get a list of current ProtocolReview documents associated with the protocol and current submission.
boolean	isProtocolInStateToBeReviewed(ProtocolBase protocol) Determine if the protocol is in a state that can be reviewed.
boolean	isProtocolReviewer(String principalId, boolean nonEmployeeFlag, ProtocolSubmissionBase protocolSubmission) Returns true if the principal has an online review for the protocol submission.
void	moveOnlineReviews(ProtocolSubmissionBase submission, ProtocolSubmissionBase newSubmission) This method is to get the online reviews, loop through them and reassign them to new protocol.
void	removeOnlineReviewDocument(String personId, boolean nonEmployeeFlag, ProtocolSubmissionBase submission, String annotation) Sets the status to Cancelled/Removed.
void	removeOnlineReviews(ProtocolSubmissionBase submission, String annotation)
void	returnProtocolOnlineReviewDocumentToReviewer(ProtocolOnlineReviewDocumentBase reviewDocument, String reason, String principalId) Return the ProtocolOnlineReviewBase document to the reviewer.

Field Detail

ONLINE_REVIEW_DOCUMENT_DESCRIPTION_FORMAT

static final String ONLINE_REVIEW_DOCUMENT_DESCRIPTION_FORMAT

See Also:

Constant Field Values

PROTOCOL_ONLINE_REVIEW_DOCUMENT_TYPE_CODE

static final String PROTOCOL_ONLINE_REVIEW_DOCUMENT_TYPE_CODE

Document type code for online review.

See Also:

Constant Field Values

Method Detail

createAndRouteProtocolOnlineReviewDocument

ProtocolOnlineReviewDocumentBase createAndRouteProtocolOnlineReviewDocument(ProtocolSubmissionBase protocolSubmission,
                                                                          ProtocolReviewer protocolReviewer,
                                                                          String documentDescription,
                                                                          String documentExplanation,
                                                                          String documentOrganizationDocumentNumber,
                                                                          String documentRouteAnnotation,
                                                                          boolean approveDocument,
                                                                          Date dateRequested,
                                                                          Date dateDue,
                                                                          String principalId)

Assign an online review to a reviewer. Reviewers must be a member of the committee. This method will create a new ProtocolReviewDocument, and the associated BO and return it. The method routes the document so it will show immediately in the reviewer's kew action list.

Parameters:

protocolSubmission - The protocol submission for which the review is being requested.

protocolReviewer - The user who will review the document.

documentDescription - The description to be used on the associated workflow document

documentExplanation - The explanation to be used on the associated workflow document

documentOrganizationDocumentNumber - the organization document number to be used on the associated workflow document

documentRouteAnnotation - - The annotation to apply to the document when routing it.

approveDocument - Should the service approve the document with the given principalID. In the case of IRB Administrators this will approve the document through the initial node.

principalId - The principalId to use when creating the document, and routing it into workflow.

Returns:

The ProtocolReviewDocument that was created.

createProtocolReviewer

ProtocolReviewer createProtocolReviewer(String principalId,
                                      boolean nonEmployeeFlag,
                                      String reviewerTypeCode,
                                      ProtocolSubmissionBase protocolSubmission)

Creates a reviewer for the protocol included in the protocolSubmission.

Parameters:

principalId - The ID of the user who will review the document

nonEmployeeFlag - Whether or not the user is an employee

reviewerTypeCode - The type of reviewer (usually primary or secondary) that this user will be

protocolSubmission - The submission which the user will review

Returns:

the ProtocolReviewer that was created

getProtocolReviewDocumentsForCurrentSubmission

List<ProtocolOnlineReviewDocumentBase> getProtocolReviewDocumentsForCurrentSubmission(ProtocolBase protocol)

Get a list of current ProtocolReview documents associated with the protocol and current submission.

Parameters:

protocol -

Returns:

getAvailableCommitteeMembersForCurrentSubmission

List<CommitteeMembershipBase> getAvailableCommitteeMembersForCurrentSubmission(ProtocolBase protocol)

This method...

Parameters:

protocol -

Returns:

getProtocolReviews

List<ProtocolOnlineReviewBase> getProtocolReviews(String protocolNumber)

Get a list of current ProtocolReview documents associated with the protocol and current submission.

Parameters:

protocolNumber -

Returns:

getProtocolReviews

List<ProtocolOnlineReviewBase> getProtocolReviews(Long submissionId)

This method returns a list of ProtocolOnlineReviewBase BOs that are associated with submission.

Parameters:

submissionId - the submissionId for which you want the ProtocolOnlineReviews.

Returns:

getProtocolReviewer

ProtocolReviewer getProtocolReviewer(String personId,
                                   boolean nonEmployeeFlag,
                                   ProtocolSubmissionBase protocolSubmission)

Returns the online reviewer for the protocol submission corresponding to the principal id, if one exists.

Parameters:

personId - The id of the person

nonEmployeeFlag - Is the person an employee or not? Determines if the personId is treated as a KIM principal or a rolodex id.

protocolSubmission - The protocol submission

Returns:

isProtocolReviewer

boolean isProtocolReviewer(String principalId,
                         boolean nonEmployeeFlag,
                         ProtocolSubmissionBase protocolSubmission)

Returns true if the principal has an online review for the protocol submission.

Parameters:

personId - The personId (Rolodex or principal) we are checking

nonEmployeeFlag - Is the person an employee or not? Determines if the personId is treated as a KIM principal or a rolodex id..

protocolSubmission - The protocolSubmission

Returns:

getProtocolOnlineReviewDocument

ProtocolOnlineReviewDocumentBase getProtocolOnlineReviewDocument(String principalId,
                                                               boolean nonEmployeeFlag,
                                                               ProtocolSubmissionBase protocolSubmission)

Returns the ProtocolOnlineReviewDocumentBase associated with the

Parameters:

personId - The personId (Rolodex or principal) we are checking

nonEmployeeFlag - Is the person an employee or not? Determines if the personId is treated as a KIM principal or a rolodex id.

protocolSubmission - The protocolSubmission

Returns:

isProtocolInStateToBeReviewed

boolean isProtocolInStateToBeReviewed(ProtocolBase protocol)

Determine if the protocol is in a state that can be reviewed. Right now checks to see if there is an active submission.

Parameters:

protocol -

Returns:

returnProtocolOnlineReviewDocumentToReviewer

void returnProtocolOnlineReviewDocumentToReviewer(ProtocolOnlineReviewDocumentBase reviewDocument,
                                                String reason,
                                                String principalId)

Return the ProtocolOnlineReviewBase document to the reviewer.

Parameters:

review -

removeOnlineReviewDocument

void removeOnlineReviewDocument(String personId,
                              boolean nonEmployeeFlag,
                              ProtocolSubmissionBase submission,
                              String annotation)

Sets the status to Cancelled/Removed. If the review document is enroute, then we do a superuser disapprove on it. If it is in saved or initiated state, then a super user cancel is performed on it. Those two actions will cause all review comments to be deleted. If the document is in final state we simply delete all of the review comments.

Parameters:

personId -

nonEmployeeFlag -

submission -

annotation -

cancelOnlineReviews

void cancelOnlineReviews(ProtocolSubmissionBase submission,
                       String annotation)

Cancels all online review documents associated with the submission.

Parameters:

submission -

annotation -

removeOnlineReviews

void removeOnlineReviews(ProtocolSubmissionBase submission,
                       String annotation)

finalizeOnlineReviews

void finalizeOnlineReviews(ProtocolSubmissionBase submission,
                         String annotation)

Finalizes all online review documents associated with the submission.

Parameters:

submission -

getProtocolOnlineReviewDocumentDescription

String getProtocolOnlineReviewDocumentDescription(String protocolNumber,
                                                String piName)

Generate the standard document description for OLR documents. Gurantees it will be less than or equal to the 40 char limit by truncating the PI name.

Parameters:

protocolNumber - the protocol number to add to the description

piName - The name of the pi to add to the description.

Returns:

String to be used in the description.

moveOnlineReviews

void moveOnlineReviews(ProtocolSubmissionBase submission,
                     ProtocolSubmissionBase newSubmission)

This method is to get the online reviews, loop through them and reassign them to new protocol. When do SMR/SRR, a new protocol will be versioned. Attach the existing OLR to the new protocol submission.

Parameters:

submission -

newSubmission -