org.kuali.kra.protocol.actions.reviewcomments

Interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

All Known Subinterfaces:

IacucReviewCommentsService, ReviewCommentsService

All Known Implementing Classes:

IacucReviewCommentsServiceImpl, ReviewCommentsServiceImpl, ReviewCommentsServiceImplBase

public interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Method Summary

Methods

Modifier and Type	Method and Description
void	addReviewAttachment(PRA newReviewAttachment, List<PRA> reviewAttachments, ProtocolBase protocol) This method is to add review attachment in OLR or manage review attachment
void	addReviewComment(CommitteeScheduleMinuteBase newReviewComment, List<CommitteeScheduleMinuteBase> reviewComments, ProtocolBase protocol) Adds the newReviewComment to the list of reviewComments in the given protocol.
void	addReviewComment(CommitteeScheduleMinuteBase newReviewComment, List<CommitteeScheduleMinuteBase> reviewComments, ProtocolOnlineReviewBase protocolOnlineReview) Adds the newReviewerComment to the list of reviewerComments in the given protocol online review.
boolean	canViewOnlineReviewerComments(String principalId, ProtocolSubmissionBase protocolSubmission) Determines whether the given principal can view the list of online reviewer comments for the given protocol submission.
boolean	canViewOnlineReviewers(String principalId, ProtocolSubmissionBase protocolSubmission) Determines whether the given principal can view the list of online reviewers for the given protocol submission.
void	deleteAllReviewAttachments(List<PRA> reviewAttachments, List<PRA> deletedReviewAttachments) This method is to delete all saved attachments
void	deleteAllReviewComments(List<CommitteeScheduleMinuteBase> reviewComments, List<CommitteeScheduleMinuteBase> deletedReviewComments) Delete all review comments from the list of reviewComments and add them all to the list of deletedReviewComments.
void	deleteReviewAttachment(List<PRA> reviewAttachments, int index, List<PRA> deletedReviewAttachments) This method is to delete a review attachment.
void	deleteReviewComment(List<CommitteeScheduleMinuteBase> reviewComments, int index, List<CommitteeScheduleMinuteBase> deletedReviewComments) Delete the review comment at index from the list of reviewComments and add it to the list of deletedReviewComments.
List<ProtocolOnlineReviewBase>	getProtocolOnlineReviews(String protocolNumber, int submissionNumber) This method is to get a list of active protocol online reviews for (possibly more than one) submission specified by the parameters.
List<ProtocolReviewer>	getProtocolReviewers(String protocolNumber, int submissionNumber) This method is to get a list or protocol reviewers for this submission.
boolean	getReviewerAcceptedCommentsView(CommitteeScheduleMinuteBase minute) This method is to check whether the Reviewer can view Accepted minute comment.
List<PRA>	getReviewerAttachments(String protocolNumber, int submissionNumber) This method is to get review attachments for submission detail
List<CommitteeScheduleMinuteBase>	getReviewerComments(String protocolNumber, int submissionNumber) Finds and returns the reviewer comments for a protocol number and a certain submission.
boolean	getReviewerCommentsView(ProtocolReviewableBase minute) This method is to check whether the current user can view this comment.
boolean	getReviewerMinuteCommentsView(CommitteeScheduleMinuteBase minute) This method is to check whether the current user can view this minute comment.
void	moveDownReviewComment(List<CommitteeScheduleMinuteBase> reviewComments, ProtocolBase protocol, int fromIndex) Moves one review comment down the list by one value.
void	moveUpReviewComment(List<CommitteeScheduleMinuteBase> reviewComments, ProtocolBase protocol, int fromIndex) Moves one review comment up the list by one value.
void	saveReviewAttachments(List<PRA> reviewAttachments, List<PRA> deletedReviewAttachments) This method is to save review attachments in OLR or manage review attachment
void	saveReviewComments(List<CommitteeScheduleMinuteBase> reviewComments, List<CommitteeScheduleMinuteBase> deletedReviewComments) Saves the given reviewComments to the database and deletes the given deletedReviewComments.
boolean	setHideReviewerName(List<? extends ProtocolReviewableBase> reviewComments) This method is to check whether there is any review comments can display reviewer name based on IRB_DISPLAY_REVIEWER_NAME parameter, and role based business rule.
boolean	setHideReviewerName(ProtocolBase protocol, int submissionNumber) This method is to check whether there is any review comments can display reviewer name based on IRB_DISPLAY_REVIEWER_NAME parameter, and role based business rule.
boolean	setHideViewButton(List<PRA> reviewAttachments) This method is to check to show 'view' button for protocol personnel

Method Detail

canViewOnlineReviewerComments

boolean canViewOnlineReviewerComments(String principalId,
                                    ProtocolSubmissionBase protocolSubmission)

Determines whether the given principal can view the list of online reviewer comments for the given protocol submission. This is true when 1) The principal is an IRB Administrator 2) The principal is an online reviewer of the given protocol submission 3) The protocol submission processing has been completed

Parameters:

principalId - the id of the user

protocolSubmission - the protocol submission

Returns:

true if the principal can view the list of online reviewer comments for the given protocol submission, false otherwise

canViewOnlineReviewers

boolean canViewOnlineReviewers(String principalId,
                             ProtocolSubmissionBase protocolSubmission)

Determines whether the given principal can view the list of online reviewers for the given protocol submission. This is true when the principal is an IRB Administrator or an online reviewer of the given protocol submission.

Parameters:

principalId - the id of the user

protocolSubmission - the protocol submission

Returns:

true if the principal can view the list of online reviewers, false otherwise

getReviewerComments

List<CommitteeScheduleMinuteBase> getReviewerComments(String protocolNumber,
                                                    int submissionNumber)

Finds and returns the reviewer comments for a protocol number and a certain submission.

Parameters:

protocolNumber - The protocol number

submissionNumber - The number of the submission

Returns:

a list of reviewer comments

getReviewerCommentsView

boolean getReviewerCommentsView(ProtocolReviewableBase minute)

This method is to check whether the current user can view this comment. This is true either if 1) The current user has the role IRB Administrator 2) The current user does not have the role IRB Administrator, but the current user is the comment creator 3) The current user does not have the role IRB Administrator, the current user is not the comment creator, but the comment is public and final

Parameters:

CommitteeScheduleMinuteBase - minute

Returns:

whether the current user can view this comment

getProtocolReviewers

List<ProtocolReviewer> getProtocolReviewers(String protocolNumber,
                                          int submissionNumber)

This method is to get a list or protocol reviewers for this submission.

Parameters:

protocolNumber -

submissionNumber -

Returns:

getProtocolOnlineReviews

List<ProtocolOnlineReviewBase> getProtocolOnlineReviews(String protocolNumber,
                                                      int submissionNumber)

This method is to get a list of active protocol online reviews for (possibly more than one) submission specified by the parameters.

Parameters:

protocolNumber -

submissionNumber -

Returns:

non-null list of active online reviews

addReviewComment

void addReviewComment(CommitteeScheduleMinuteBase newReviewComment,
                    List<CommitteeScheduleMinuteBase> reviewComments,
                    ProtocolBase protocol)

Adds the newReviewComment to the list of reviewComments in the given protocol.

Parameters:

newReviewComment - the new review comment to add

reviewComments - the list of reviewer comments

protocol - the current protocol

addReviewComment

void addReviewComment(CommitteeScheduleMinuteBase newReviewComment,
                    List<CommitteeScheduleMinuteBase> reviewComments,
                    ProtocolOnlineReviewBase protocolOnlineReview)

Adds the newReviewerComment to the list of reviewerComments in the given protocol online review.

Parameters:

newReviewComment - the new review comment to add

reviewComments - the list of reviewer comments

protocolOnlineReview - the current protocol online review

moveUpReviewComment

void moveUpReviewComment(List<CommitteeScheduleMinuteBase> reviewComments,
                       ProtocolBase protocol,
                       int fromIndex)

Moves one review comment up the list by one value.

Parameters:

reviewComments - the list of review comments

protocol - the current protocol

fromIndex - the current position of the review comment

moveDownReviewComment

void moveDownReviewComment(List<CommitteeScheduleMinuteBase> reviewComments,
                         ProtocolBase protocol,
                         int fromIndex)

Moves one review comment down the list by one value.

Parameters:

reviewComments - the list of reviewer comments

protocol - the current protocol

fromIndex - the current position of the review comment

deleteReviewComment

void deleteReviewComment(List<CommitteeScheduleMinuteBase> reviewComments,
                       int index,
                       List<CommitteeScheduleMinuteBase> deletedReviewComments)

Delete the review comment at index from the list of reviewComments and add it to the list of deletedReviewComments.

Parameters:

reviewComments - the list of reviewer comments

index - the index of the reviewer comment to be deleted

deletedReviewComments - the list of deleted reviewer comments

deleteAllReviewComments

void deleteAllReviewComments(List<CommitteeScheduleMinuteBase> reviewComments,
                           List<CommitteeScheduleMinuteBase> deletedReviewComments)

Delete all review comments from the list of reviewComments and add them all to the list of deletedReviewComments.

Parameters:

reviewComments - the list of reviewer comments

deletedReviewComments - the list of deleted reviewer comments

saveReviewComments

void saveReviewComments(List<CommitteeScheduleMinuteBase> reviewComments,
                      List<CommitteeScheduleMinuteBase> deletedReviewComments)

Saves the given reviewComments to the database and deletes the given deletedReviewComments.

Parameters:

reviewComments - the review comments that will be saved

deletedReviewComments - the review comments that will be deleted

setHideReviewerName

boolean setHideReviewerName(ProtocolBase protocol,
                          int submissionNumber)

This method is to check whether there is any review comments can display reviewer name based on IRB_DISPLAY_REVIEWER_NAME parameter, and role based business rule. This is called by protocol action helper.

Parameters:

protocol -

submissionNumber -

Returns:

setHideReviewerName

boolean setHideReviewerName(List<? extends ProtocolReviewableBase> reviewComments)

This method is to check whether there is any review comments can display reviewer name based on IRB_DISPLAY_REVIEWER_NAME parameter, and role based business rule.

Parameters:

reviewComments -

Returns:

getReviewerMinuteCommentsView

boolean getReviewerMinuteCommentsView(CommitteeScheduleMinuteBase minute)

This method is to check whether the current user can view this minute comment.

Parameters:

CommitteeScheduleMinuteBase - minute

Returns:

whether the current user can view this comment

getReviewerAcceptedCommentsView

boolean getReviewerAcceptedCommentsView(CommitteeScheduleMinuteBase minute)

This method is to check whether the Reviewer can view Accepted minute comment.

Parameters:

CommitteeScheduleMinuteBase - minute

Returns:

whether the current user can view this comment

deleteReviewAttachment

void deleteReviewAttachment(List<PRA> reviewAttachments,
                          int index,
                          List<PRA> deletedReviewAttachments)

This method is to delete a review attachment.

Parameters:

reviewAttachments -

index -

deletedReviewAttachments -

saveReviewAttachments

void saveReviewAttachments(List<PRA> reviewAttachments,
                         List<PRA> deletedReviewAttachments)

This method is to save review attachments in OLR or manage review attachment

Parameters:

reviewAttachments -

deletedReviewAttachments -

deleteAllReviewAttachments

void deleteAllReviewAttachments(List<PRA> reviewAttachments,
                              List<PRA> deletedReviewAttachments)

This method is to delete all saved attachments

Parameters:

reviewAttachments -

deletedReviewAttachments -

addReviewAttachment

void addReviewAttachment(PRA newReviewAttachment,
                       List<PRA> reviewAttachments,
                       ProtocolBase protocol)

This method is to add review attachment in OLR or manage review attachment

Parameters:

newReviewAttachment -

reviewAttachments -

protocol -

getReviewerAttachments

List<PRA> getReviewerAttachments(String protocolNumber,
                               int submissionNumber)

This method is to get review attachments for submission detail

Parameters:

protocolNumber -

submissionNumber -

Returns:

setHideViewButton

boolean setHideViewButton(List<PRA> reviewAttachments)

This method is to check to show 'view' button for protocol personnel

Parameters:

reviewAttachments -

Returns: