org.kuali.kra.protocol.actions.reviewcomments

Class ReviewCommentsServiceImplBase<PRA extends ProtocolReviewAttachmentBase>

java.lang.Object

org.kuali.kra.protocol.actions.reviewcomments.ReviewCommentsServiceImplBase<PRA>

All Implemented Interfaces:

ReviewCommentsService<PRA>

Direct Known Subclasses:

IacucReviewCommentsServiceImpl, ReviewCommentsServiceImpl

public abstract class ReviewCommentsServiceImplBase<PRA extends ProtocolReviewAttachmentBase>
extends Object
implements ReviewCommentsService<PRA>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService

Constructor Summary

Constructors

Constructor and Description
ReviewCommentsServiceImplBase()

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.
Set<String>	getAdminIds()
protected abstract String	getAdministratorRoleHook()
List<String>	getAdminUserNames()
protected abstract String	getAggregatorRoleNameHook()
protected abstract Class<? extends CommitteeScheduleMinuteBase>	getCommitteeScheduleMinuteBOClassHook()
protected abstract String	getDisplayRevNameToActiveCmtMembersHook()
protected abstract String	getDisplayRevNameToProtocolPersonnelHook()
protected abstract String	getDisplayRevNameToReviewersHook()
protected abstract String	getNamespaceHook()
protected abstract Class<? extends ProtocolDocumentBase>	getProtocolDocumentBOClassHook()
ProtocolFinderDao	getProtocolFinderDao()
protected abstract Class<? extends ProtocolOnlineReviewBase>	getProtocolOnlineReviewClassHook()
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.
protected abstract Class<PRA>	getProtocolReviewAttachmentClassHook()
protected abstract Class<? extends ProtocolReviewer>	getProtocolReviewClassHook()
List<ProtocolReviewer>	getProtocolReviewers(String protocolNumber, int submissionNumber) This method is to get a list or protocol reviewers for this submission.
protected abstract String[]	getProtocolSubmissionCompleteStatusCodeArrayHook()
protected abstract String	getProtocolViewerRoleNameHook()
boolean	getReviewerAcceptedCommentsView(CommitteeScheduleMinuteBase minute) Returns whether the Reviewer can view this accepted minute Comments in print.
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) Returns whether the current user can view this comment.
List<String>	getReviewerIds()
boolean	getReviewerMinuteCommentsView(CommitteeScheduleMinuteBase minute) Returns whether the current user can view this non Final Comments and Private Comment.
protected abstract ProtocolSubmissionBase	getSubmission(ProtocolBase protocol)
protected boolean	isActiveCommitteeMember(ProtocolReviewableBase minute, String principalId) This method determines if the current user is an active committee member
protected boolean	isActiveCommitteeMember(String committeeId, String scheduleId, String principalId)
protected boolean	isCurrentMinuteEntry(CommitteeScheduleMinuteBase minute)
boolean	isDisplayReviewerNameToActiveMembers()
boolean	isDisplayReviewerNameToPersonnel()
boolean	isDisplayReviewerNameToReviewers()
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.
abstract 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.
void	setAdminIds(Set<String> adminIds)
void	setAdminUserNames(List<String> adminUserNames)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setCommitteeScheduleService(CommitteeScheduleServiceBase committeeScheduleService)
void	setCommitteeService(CommitteeServiceBase committeeService)
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
void	setDisplayReviewerNameToActiveMembers(boolean displayReviewerNameToActiveMembers)
void	setDisplayReviewerNameToPersonnel(boolean displayReviewerNameToPersonnel)
void	setDisplayReviewerNameToReviewers(boolean displayReviewerNameToReviewers)
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
void	setKcPersonService(KcPersonService kcPersonService)
void	setKimRoleManagementService(org.kuali.rice.kim.api.role.RoleService kimRoleManagementService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setProtocolFinderDao(ProtocolFinderDao protocolFinderDao)
void	setReviewerIds(List<String> reviewerIds)
void	setRoleService(org.kuali.rice.kim.api.role.RoleService roleService)

Methods inherited from class java.lang.Object

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

Field Detail

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

Constructor Detail

ReviewCommentsServiceImplBase

public ReviewCommentsServiceImplBase()

Method Detail

canViewOnlineReviewerComments

public 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

Specified by:

canViewOnlineReviewerComments in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

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

See Also:

ReviewCommentsService.canViewOnlineReviewerComments(java.lang.String, org.kuali.kra.protocol.actions.submit.ProtocolSubmissionBase)

canViewOnlineReviewers

public 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.

Specified by:

canViewOnlineReviewers in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

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

See Also:

ReviewCommentsService.canViewOnlineReviewers(java.lang.String, org.kuali.kra.protocol.actions.submit.ProtocolSubmissionBase)

getProtocolSubmissionCompleteStatusCodeArrayHook

protected abstract String[] getProtocolSubmissionCompleteStatusCodeArrayHook()

getReviewerComments

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

Description copied from interface: ReviewCommentsService

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

Specified by:

getReviewerComments in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

protocolNumber - The protocol number

submissionNumber - The number of the submission

Returns:

a list of reviewer comments

getCommitteeScheduleMinuteBOClassHook

protected abstract Class<? extends CommitteeScheduleMinuteBase> getCommitteeScheduleMinuteBOClassHook()

getReviewerAttachments

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

Description copied from interface: ReviewCommentsService

This method is to get review attachments for submission detail

Specified by:

getReviewerAttachments in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Returns:

getProtocolReviewers

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

Description copied from interface: ReviewCommentsService

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

Specified by:

getProtocolReviewers in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Returns:

getProtocolOnlineReviews

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

Description copied from interface: ReviewCommentsService

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

Specified by:

getProtocolOnlineReviews in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Returns:

non-null list of active online reviews

isCurrentMinuteEntry

protected boolean isCurrentMinuteEntry(CommitteeScheduleMinuteBase minute)

addReviewComment

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

Description copied from interface: ReviewCommentsService

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

Specified by:

addReviewComment in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

newReviewComment - the new review comment to add

reviewComments - the list of reviewer comments

protocol - the current protocol

addReviewComment

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

Description copied from interface: ReviewCommentsService

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

Specified by:

addReviewComment in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

newReviewComment - the new review comment to add

reviewComments - the list of reviewer comments

protocolOnlineReview - the current protocol online review

moveUpReviewComment

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

Description copied from interface: ReviewCommentsService

Moves one review comment up the list by one value.

Specified by:

moveUpReviewComment in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

reviewComments - the list of review comments

protocol - the current protocol

fromIndex - the current position of the review comment

moveDownReviewComment

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

Description copied from interface: ReviewCommentsService

Moves one review comment down the list by one value.

Specified by:

moveDownReviewComment in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

reviewComments - the list of reviewer comments

protocol - the current protocol

fromIndex - the current position of the review comment

getReviewerCommentsView

public boolean getReviewerCommentsView(ProtocolReviewableBase minute)

Returns whether the current user can view this comment. This is true either if 1) The current user has the role IRB Administrator 2) The comment/minute has been accepted by an IRB Administrator and one of the following conditions is true: 3) The current user does not have the role IRB Administrator, but the current user is the comment creator 4) The current user does not have the role IRB Administrator, but is a reviewer of the protocol, and not part of the protocol personnel, and the comment is final 5) The current user does not have the role IRB Administrator, but is an active committee member, and not part of the protocol personnel, and the comment is final 6) The comment is public and final In addition if the comment is not associated with an online review then it automatically returns true.

Specified by:

getReviewerCommentsView in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

CommitteeScheduleMinuteBase - minute

Returns:

whether the current user can view this comment

getAdministratorRoleHook

protected abstract String getAdministratorRoleHook()

deleteReviewComment

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

Description copied from interface: ReviewCommentsService

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

Specified by:

deleteReviewComment in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

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

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

Description copied from interface: ReviewCommentsService

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

Specified by:

deleteAllReviewComments in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

reviewComments - the list of reviewer comments

deletedReviewComments - the list of deleted reviewer comments

saveReviewComments

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

Description copied from interface: ReviewCommentsService

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

Specified by:

saveReviewComments in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

reviewComments - the review comments that will be saved

deletedReviewComments - the review comments that will be deleted

getSubmission

protected abstract ProtocolSubmissionBase getSubmission(ProtocolBase protocol)

setBusinessObjectService

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

setCommitteeScheduleService

public void setCommitteeScheduleService(CommitteeScheduleServiceBase committeeScheduleService)

setCommitteeService

public void setCommitteeService(CommitteeServiceBase committeeService)

setProtocolFinderDao

public void setProtocolFinderDao(ProtocolFinderDao protocolFinderDao)

setRoleService

public void setRoleService(org.kuali.rice.kim.api.role.RoleService roleService)

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

getDisplayRevNameToActiveCmtMembersHook

protected abstract String getDisplayRevNameToActiveCmtMembersHook()

getDisplayRevNameToProtocolPersonnelHook

protected abstract String getDisplayRevNameToProtocolPersonnelHook()

getDisplayRevNameToReviewersHook

protected abstract String getDisplayRevNameToReviewersHook()

getProtocolDocumentBOClassHook

protected abstract Class<? extends ProtocolDocumentBase> getProtocolDocumentBOClassHook()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

setHideReviewerName

public boolean setHideReviewerName(ProtocolBase protocol,
                          int submissionNumber)

Description copied from interface: ReviewCommentsService

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.

Specified by:

setHideReviewerName in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Returns:

See Also:

org.kuali.kra.irb.actions.reviewcomments.ReviewCommentsService#setHideReviewerName(org.kuali.kra.irb.ProtocolBase, int)

setHideReviewerName

public boolean setHideReviewerName(List<? extends ProtocolReviewableBase> reviewComments)

Description copied from interface: ReviewCommentsService

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.

Specified by:

setHideReviewerName in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Returns:

setHideViewButton

public boolean setHideViewButton(List<PRA> reviewAttachments)

Description copied from interface: ReviewCommentsService

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

Specified by:

setHideViewButton in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Returns:

getReviewerMinuteCommentsView

public boolean getReviewerMinuteCommentsView(CommitteeScheduleMinuteBase minute)

Returns whether the current user can view this non Final Comments and Private Comment.

Specified by:

getReviewerMinuteCommentsView in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

CommitteeScheduleMinuteBase - minute

Returns:

whether the current user can view this comment

getProtocolReviewClassHook

protected abstract Class<? extends ProtocolReviewer> getProtocolReviewClassHook()

getNamespaceHook

protected abstract String getNamespaceHook()

getAggregatorRoleNameHook

protected abstract String getAggregatorRoleNameHook()

getProtocolViewerRoleNameHook

protected abstract String getProtocolViewerRoleNameHook()

setKimRoleManagementService

public void setKimRoleManagementService(org.kuali.rice.kim.api.role.RoleService kimRoleManagementService)

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)

getAdminIds

public Set<String> getAdminIds()

setAdminIds

public void setAdminIds(Set<String> adminIds)

getAdminUserNames

public List<String> getAdminUserNames()

setAdminUserNames

public void setAdminUserNames(List<String> adminUserNames)

getReviewerIds

public List<String> getReviewerIds()

setReviewerIds

public void setReviewerIds(List<String> reviewerIds)

isDisplayReviewerNameToPersonnel

public boolean isDisplayReviewerNameToPersonnel()

setDisplayReviewerNameToPersonnel

public void setDisplayReviewerNameToPersonnel(boolean displayReviewerNameToPersonnel)

isDisplayReviewerNameToReviewers

public boolean isDisplayReviewerNameToReviewers()

setDisplayReviewerNameToReviewers

public void setDisplayReviewerNameToReviewers(boolean displayReviewerNameToReviewers)

isDisplayReviewerNameToActiveMembers

public boolean isDisplayReviewerNameToActiveMembers()

setDisplayReviewerNameToActiveMembers

public void setDisplayReviewerNameToActiveMembers(boolean displayReviewerNameToActiveMembers)

isActiveCommitteeMember

protected boolean isActiveCommitteeMember(ProtocolReviewableBase minute,
                              String principalId)

This method determines if the current user is an active committee member

Parameters:

minute -

principalId -

Returns:

true if and active committee member, false otherwise.

isActiveCommitteeMember

protected boolean isActiveCommitteeMember(String committeeId,
                              String scheduleId,
                              String principalId)

getReviewerAcceptedCommentsView

public boolean getReviewerAcceptedCommentsView(CommitteeScheduleMinuteBase minute)

Returns whether the Reviewer can view this accepted minute Comments in print.

Specified by:

getReviewerAcceptedCommentsView in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

Parameters:

CommitteeScheduleMinuteBase - minute

Returns:

whether the current user can view this comment

getProtocolOnlineReviewClassHook

protected abstract Class<? extends ProtocolOnlineReviewBase> getProtocolOnlineReviewClassHook()

deleteReviewAttachment

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

Description copied from interface: ReviewCommentsService

This method is to delete a review attachment.

Specified by:

deleteReviewAttachment in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

saveReviewAttachments

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

Description copied from interface: ReviewCommentsService

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

Specified by:

saveReviewAttachments in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

addReviewAttachment

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

Description copied from interface: ReviewCommentsService

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

Specified by:

addReviewAttachment in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

getProtocolReviewAttachmentClassHook

protected abstract Class<PRA> getProtocolReviewAttachmentClassHook()

deleteAllReviewAttachments

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

Description copied from interface: ReviewCommentsService

This method is to delete all saved attachments

Specified by:

deleteAllReviewAttachments in interface ReviewCommentsService<PRA extends ProtocolReviewAttachmentBase>

getProtocolFinderDao

public ProtocolFinderDao getProtocolFinderDao()