public abstract class ProtocolOnlineReviewServiceImplBase extends Object implements ProtocolOnlineReviewService
| Modifier and Type | Field and Description |
|---|---|
protected org.kuali.rice.krad.service.BusinessObjectService |
businessObjectService |
protected CommitteeServiceBase |
committeeService |
protected org.kuali.rice.krad.service.DocumentService |
documentService |
protected org.kuali.rice.kim.api.identity.IdentityService |
identityManagementService |
protected KraAuthorizationService |
kraAuthorizationService |
protected KraDocumentRejectionService |
kraDocumentRejectionService |
protected org.kuali.rice.kim.api.identity.PersonService |
personService |
protected ProtocolAssignReviewersService |
protocolAssignReviewersService |
protected ProtocolFinderDao |
protocolFinderDao |
protected ReviewCommentsService |
reviewCommentsService |
protected String |
reviewerApproveNodeName |
protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService |
workflowDocumentService |
ONLINE_REVIEW_DOCUMENT_DESCRIPTION_FORMAT, PROTOCOL_ONLINE_REVIEW_DOCUMENT_TYPE_CODE| Constructor and Description |
|---|
ProtocolOnlineReviewServiceImplBase() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
cancelOnlineReviewDocument(ProtocolOnlineReviewDocumentBase protocolOnlineReviewDocument,
ProtocolSubmissionBase submission,
String annotation) |
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 initialApproval,
Date dateRequested,
Date dateDue,
String principalId)
Assign an online review to a reviewer.
|
protected abstract ProtocolReviewer |
createNewProtocolReviewerInstanceHook() |
protected ProtocolOnlineReviewDocumentBase |
createProtocolOnlineReviewDocument(ProtocolSubmissionBase protocolSubmission,
ProtocolReviewer protocolReviewer,
String documentDescription,
String documentExplanation,
String documentOrganizationDocumentNumber,
Date dateRequested,
Date dateDue,
String principalId)
Creates a new ProtocolReviewDocument.
|
ProtocolReviewer |
createProtocolReviewer(String principalId,
boolean nonEmployeeFlag,
String reviewerTypeCode,
ProtocolSubmissionBase protocolSubmission)
Creates a reviewer for the protocol included in the protocolSubmission.
|
protected void |
finalizeOnlineReviewDocument(ProtocolOnlineReviewDocumentBase protocolOnlineReviewDocument,
ProtocolSubmissionBase submission,
String annotation) |
void |
finalizeOnlineReviews(ProtocolSubmissionBase submission,
String annotation)
Finalizes all online review documents associated with the submission.
|
protected List<ProtocolOnlineReviewBase> |
findProtocolOnlineReviews(Long protocolId,
Long submissionIdFk)
Finds and returns all protocol online reviews for the protocolId and submissionId.
|
List<CommitteeMembershipBase> |
getAvailableCommitteeMembersForCurrentSubmission(ProtocolBase protocol)
This method...
|
org.kuali.rice.krad.service.BusinessObjectService |
getBusinessObjectService() |
CommitteeServiceBase |
getCommitteeService()
Gets the committeeService attribute.
|
org.kuali.rice.krad.service.DocumentService |
getDocumentService() |
KraAuthorizationService |
getKraAuthorizationService() |
KraDocumentRejectionService |
getKraDocumentRejectionService()
Gets the kraDocumentRejectionService attribute.
|
KraWorkflowService |
getKraWorkflowService()
Gets the workflowDocumentService attribute.
|
protected abstract ProtocolOnlineReviewDocumentBase |
getNewProtocolOnlineReviewDocumentInstanceHook() |
org.kuali.rice.kim.api.identity.PersonService |
getPersonService()
Gets the personService attribute.
|
ProtocolAssignReviewersService |
getProtocolAssignReviewersService() |
protected abstract String |
getProtocolOLRDocumentTypeHook() |
protected abstract String |
getProtocolOLRRemovedCancelledStatusCodeHook() |
protected abstract String |
getProtocolOLRSavedStatusCodeHook() |
protected abstract Class<? extends ProtocolOnlineReviewBase> |
getProtocolOnlineReviewBOClassHook() |
ProtocolOnlineReviewDocumentBase |
getProtocolOnlineReviewDocument(String personId,
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.
|
protected abstract Class<? extends ProtocolSubmissionBase> |
getProtocolSubmissionBOClassHook() |
String |
getReviewerApproveNodeName()
Gets the reviewerApproveNodeName attribute.
|
ReviewCommentsService |
getReviewerCommentsService() |
org.kuali.rice.krad.workflow.service.WorkflowDocumentService |
getWorkflowDocumentService()
Gets the workflowDocumentService attribute.
|
boolean |
isProtocolReviewer(String personId,
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.
|
protected void |
removeOnlineReviewDocument(ProtocolOnlineReviewDocumentBase protocolOnlineReviewDocument,
ProtocolSubmissionBase submission,
String annotation) |
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.
|
void |
setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) |
void |
setCommitteeService(CommitteeServiceBase committeeService)
Sets the committeeService attribute value.
|
void |
setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) |
void |
setIdentityManagementService(org.kuali.rice.kim.api.identity.IdentityService identityManagementService)
Sets the identityManagementService attribute value.
|
void |
setKraAuthorizationService(KraAuthorizationService kraAuthorizationService) |
void |
setKraDocumentRejectionService(KraDocumentRejectionService kraDocumentRejectionService)
Sets the kraDocumentRejectionService attribute value.
|
void |
setPersonService(org.kuali.rice.kim.api.identity.PersonService personService)
Sets the personService attribute value.
|
void |
setProtocolAssignReviewersService(ProtocolAssignReviewersService protocolAssignReviewersService) |
void |
setProtocolFinderDao(ProtocolFinderDao protocolFinderDao)
Sets the protocolFinderDao attribute value.
|
void |
setReviewCommentsService(ReviewCommentsService reviewCommentsService) |
void |
setReviewerApproveNodeName(String reviewerApproveNodeName)
Sets the reviewerApproveNodeName attribute value.
|
void |
setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitisProtocolInStateToBeReviewedprotected org.kuali.rice.krad.service.BusinessObjectService businessObjectService
protected org.kuali.rice.krad.service.DocumentService documentService
protected KraAuthorizationService kraAuthorizationService
protected ProtocolAssignReviewersService protocolAssignReviewersService
protected org.kuali.rice.kim.api.identity.IdentityService identityManagementService
protected CommitteeServiceBase committeeService
protected KraDocumentRejectionService kraDocumentRejectionService
protected ProtocolFinderDao protocolFinderDao
protected ReviewCommentsService reviewCommentsService
protected org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService
protected String reviewerApproveNodeName
protected org.kuali.rice.kim.api.identity.PersonService personService
public ProtocolOnlineReviewDocumentBase createAndRouteProtocolOnlineReviewDocument(ProtocolSubmissionBase protocolSubmission, ProtocolReviewer protocolReviewer, String documentDescription, String documentExplanation, String documentOrganizationDocumentNumber, String documentRouteAnnotation, boolean initialApproval, Date dateRequested, Date dateDue, String principalId)
createAndRouteProtocolOnlineReviewDocument in interface ProtocolOnlineReviewServiceprotocolSubmission - 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 documentdocumentExplanation - The explanation to be used on the associated workflow documentdocumentOrganizationDocumentNumber - the organization document number to be used on the associated workflow documentdocumentRouteAnnotation - - The annotation to apply to the document when routing it.initialApproval - 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.org.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewService#createAndRouteProtocolOnlineReviewDocument(
org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase, org.kuali.kra.irb.actions.submit.ProtocolReviewerBeanBase, java.lang.String, java.lang.String,
java.lang.String, java.lang.String, boolean, java.sql.Date, java.sql.Date, java.lang.String)protected ProtocolOnlineReviewDocumentBase createProtocolOnlineReviewDocument(ProtocolSubmissionBase protocolSubmission, ProtocolReviewer protocolReviewer, String documentDescription, String documentExplanation, String documentOrganizationDocumentNumber, Date dateRequested, Date dateDue, String principalId) throws org.kuali.rice.kew.api.exception.WorkflowException
protocolSubmission - The protocol submissionprotocolReviewerBean - The bean that holdsdocumentDescription - the description for the created documentdocumentExplanation - the explanation for the created documentdocumentOrganizationNumber - the organizationNumber for the created documentprincipalId - The principalId to use when creating the workflow document. Usually this should be the principal of the user creating the review.org.kuali.rice.kew.api.exception.WorkflowExceptionprotected abstract ProtocolOnlineReviewDocumentBase getNewProtocolOnlineReviewDocumentInstanceHook()
protected abstract String getProtocolOLRSavedStatusCodeHook()
protected abstract String getProtocolOLRDocumentTypeHook()
public ProtocolReviewer createProtocolReviewer(String principalId, boolean nonEmployeeFlag, String reviewerTypeCode, ProtocolSubmissionBase protocolSubmission)
createProtocolReviewer in interface ProtocolOnlineReviewServiceprincipalId - The ID of the user who will review the documentnonEmployeeFlag - Whether or not the user is an employeereviewerTypeCode - The type of reviewer (usually primary or secondary) that this user will beprotocolSubmission - The submission which the user will revieworg.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewService#createProtocolReviewer(java.lang.String, boolean, java.lang.String,
org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase)protected abstract ProtocolReviewer createNewProtocolReviewerInstanceHook()
public List<ProtocolOnlineReviewDocumentBase> getProtocolReviewDocumentsForCurrentSubmission(ProtocolBase protocol)
ProtocolOnlineReviewServicegetProtocolReviewDocumentsForCurrentSubmission in interface ProtocolOnlineReviewServiceProtocolOnlineReviewService.getProtocolReviewDocumentsForCurrentSubmission(org.kuali.kra.protocol.ProtocolBase)public List<CommitteeMembershipBase> getAvailableCommitteeMembersForCurrentSubmission(ProtocolBase protocol)
ProtocolOnlineReviewServicepublic List<ProtocolOnlineReviewBase> getProtocolReviews(String protocolNumber)
getProtocolReviews in interface ProtocolOnlineReviewServiceorg.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewService#getProtocolReviewsForCurrentSubmission(java.lang.String)public List<ProtocolOnlineReviewBase> getProtocolReviews(Long submissionId)
getProtocolReviews in interface ProtocolOnlineReviewServicesubmissionId - the submissionId for which you want the ProtocolOnlineReviews.ProtocolOnlineReviewService.getProtocolReviews(java.lang.Long)protected abstract Class<? extends ProtocolSubmissionBase> getProtocolSubmissionBOClassHook()
public ProtocolReviewer getProtocolReviewer(String personId, boolean nonEmployeeFlag, ProtocolSubmissionBase protocolSubmission)
getProtocolReviewer in interface ProtocolOnlineReviewServicepersonId - The id of the personnonEmployeeFlag - Is the person an employee or not? Determines if the personId is treated as a KIM principal or a rolodex id.protocolSubmission - The protocol submissionorg.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewService#getProtocolReviewer(java.lang.String,
org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase)public ProtocolOnlineReviewDocumentBase getProtocolOnlineReviewDocument(String personId, boolean nonEmployeeFlag, ProtocolSubmissionBase protocolSubmission)
ProtocolOnlineReviewServicegetProtocolOnlineReviewDocument in interface ProtocolOnlineReviewServicenonEmployeeFlag - Is the person an employee or not? Determines if the personId is treated as a KIM principal or a rolodex id.protocolSubmission - The protocolSubmissionorg.kuali.kra.irb.onlinereview.ProtocolOnlineReviewService#getProtocolOnlineReviewDocument(java.lang.String, boolean, org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase)public boolean isProtocolReviewer(String personId, boolean nonEmployeeFlag, ProtocolSubmissionBase protocolSubmission)
isProtocolReviewer in interface ProtocolOnlineReviewServicenonEmployeeFlag - Is the person an employee or not? Determines if the personId is treated as a KIM principal or a rolodex id..protocolSubmission - The protocolSubmissionorg.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewService#isUserAnOnlineReviewerOfProtocol(java.lang.String, org.kuali.kra.protocol.ProtocolBase)public void returnProtocolOnlineReviewDocumentToReviewer(ProtocolOnlineReviewDocumentBase reviewDocument, String reason, String principalId)
ProtocolOnlineReviewServicereturnProtocolOnlineReviewDocumentToReviewer in interface ProtocolOnlineReviewServiceprotected List<ProtocolOnlineReviewBase> findProtocolOnlineReviews(Long protocolId, Long submissionIdFk)
protocolId - submissionIdFk - protected abstract Class<? extends ProtocolOnlineReviewBase> getProtocolOnlineReviewBOClassHook()
protected void cancelOnlineReviewDocument(ProtocolOnlineReviewDocumentBase protocolOnlineReviewDocument, ProtocolSubmissionBase submission, String annotation)
protected void finalizeOnlineReviewDocument(ProtocolOnlineReviewDocumentBase protocolOnlineReviewDocument, ProtocolSubmissionBase submission, String annotation)
protected void removeOnlineReviewDocument(ProtocolOnlineReviewDocumentBase protocolOnlineReviewDocument, ProtocolSubmissionBase submission, String annotation)
public void removeOnlineReviewDocument(String personId, boolean nonEmployeeFlag, ProtocolSubmissionBase submission, String annotation)
ProtocolOnlineReviewServiceremoveOnlineReviewDocument in interface ProtocolOnlineReviewServiceorg.kuali.kra.irb.onlinereview.ProtocolOnlineReviewService#removeOnlineReviewDocument(java.lang.String, boolean, org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase, java.lang.String)protected abstract String getProtocolOLRRemovedCancelledStatusCodeHook()
public void cancelOnlineReviews(ProtocolSubmissionBase submission, String annotation)
cancelOnlineReviews in interface ProtocolOnlineReviewServiceorg.kuali.kra.irb.onlinereview.ProtocolOnlineReviewService#cancelOnlineReviews(org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase,
java.lang.String)public void finalizeOnlineReviews(ProtocolSubmissionBase submission, String annotation)
ProtocolOnlineReviewServicefinalizeOnlineReviews in interface ProtocolOnlineReviewServiceorg.kuali.kra.irb.onlinereview.ProtocolOnlineReviewService#finalizeOnlineReviews(org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase)public void removeOnlineReviews(ProtocolSubmissionBase submission, String annotation)
removeOnlineReviews in interface ProtocolOnlineReviewServiceorg.kuali.kra.irb.onlinereview.ProtocolOnlineReviewService#finalizeOnlineReviews(org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase)public void moveOnlineReviews(ProtocolSubmissionBase submission, ProtocolSubmissionBase newSubmission)
ProtocolOnlineReviewServicemoveOnlineReviews in interface ProtocolOnlineReviewServiceorg.kuali.kra.irb.onlinereview.ProtocolOnlineReviewService#moveOnlineReviews(org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase, org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase)public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()
public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
public org.kuali.rice.krad.service.DocumentService getDocumentService()
public void setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)
public KraAuthorizationService getKraAuthorizationService()
public void setProtocolAssignReviewersService(ProtocolAssignReviewersService protocolAssignReviewersService)
public ProtocolAssignReviewersService getProtocolAssignReviewersService()
public org.kuali.rice.krad.workflow.service.WorkflowDocumentService getWorkflowDocumentService()
public KraWorkflowService getKraWorkflowService()
public org.kuali.rice.kim.api.identity.PersonService getPersonService()
public void setPersonService(org.kuali.rice.kim.api.identity.PersonService personService)
personService - The personService to set.public void setIdentityManagementService(org.kuali.rice.kim.api.identity.IdentityService identityManagementService)
identityManagementService - The identityManagementService to set.public CommitteeServiceBase getCommitteeService()
public void setCommitteeService(CommitteeServiceBase committeeService)
committeeService - The committeeService to set.public String getReviewerApproveNodeName()
public void setReviewerApproveNodeName(String reviewerApproveNodeName)
reviewerApproveNodeName - The reviewerApproveNodeName to set.public KraDocumentRejectionService getKraDocumentRejectionService()
public void setKraDocumentRejectionService(KraDocumentRejectionService kraDocumentRejectionService)
kraDocumentRejectionService - The kraDocumentRejectionService to set.public void setProtocolFinderDao(ProtocolFinderDao protocolFinderDao)
protocolFinderDao - The protocolFinderDao to set.public ReviewCommentsService getReviewerCommentsService()
public void setReviewCommentsService(ReviewCommentsService reviewCommentsService)
public String getProtocolOnlineReviewDocumentDescription(String protocolNumber, String piName)
ProtocolOnlineReviewServicegetProtocolOnlineReviewDocumentDescription in interface ProtocolOnlineReviewServiceprotocolNumber - the protocol number to add to the descriptionpiName - The name of the pi to add to the description.public void setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)
Copyright © 2013 The Kuali Foundation. All Rights Reserved.