org.kuali.kra.iacuc.onlinereview

Class IacucProtocolOnlineReviewServiceImpl

java.lang.Object

org.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewServiceImplBase

org.kuali.kra.iacuc.onlinereview.IacucProtocolOnlineReviewServiceImpl

All Implemented Interfaces:

IacucProtocolOnlineReviewService, ProtocolOnlineReviewService

public class IacucProtocolOnlineReviewServiceImpl
extends ProtocolOnlineReviewServiceImplBase
implements IacucProtocolOnlineReviewService

Field Summary

Fields inherited from class org.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewServiceImplBase

businessObjectService, committeeService, documentService, identityManagementService, kraAuthorizationService, kraDocumentRejectionService, personService, protocolAssignReviewersService, protocolFinderDao, reviewCommentsService, reviewerApproveNodeName, workflowDocumentService

Fields inherited from interface org.kuali.kra.iacuc.onlinereview.IacucProtocolOnlineReviewService

IACUC_PROTOCOL_ONLINE_REVIEW_DOCUMENT_TYPE

Fields inherited from interface org.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewService

ONLINE_REVIEW_DOCUMENT_DESCRIPTION_FORMAT, PROTOCOL_ONLINE_REVIEW_DOCUMENT_TYPE_CODE

Constructor Summary

Constructors

Constructor and Description
IacucProtocolOnlineReviewServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
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 ProtocolReviewer	createNewProtocolReviewerInstanceHook()
ProtocolOnlineReviewDocumentBase	createProtocolOnlineReviewDocument(ProtocolSubmissionBase protocolSubmission, ProtocolReviewer protocolReviewer, String documentDescription, String documentExplanation, String documentOrganizationDocumentNumber, Date dateRequested, Date dateDue, String principalId) Creates a new ProtocolReviewDocument.
protected ProtocolOnlineReviewDocumentBase	getNewProtocolOnlineReviewDocumentInstanceHook()
protected String	getProtocolOLRDocumentTypeHook()
protected String	getProtocolOLRRemovedCancelledStatusCodeHook()
protected String	getProtocolOLRSavedStatusCodeHook()
protected Class<? extends ProtocolOnlineReviewBase>	getProtocolOnlineReviewBOClassHook()
protected Class<? extends ProtocolSubmissionBase>	getProtocolSubmissionBOClassHook()
boolean	isProtocolInStateToBeReviewed(ProtocolBase protocol) Determine if the protocol is in a state that can be reviewed.
void	removeOnlineReviewDocument(String personId, boolean nonEmployeeFlag, ProtocolSubmissionBase submission, String annotation) Sets the status to Cancelled/Removed.
void	setKraWorkflowService(KraWorkflowService kraWorkflowService)

Methods inherited from class org.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewServiceImplBase

cancelOnlineReviewDocument, cancelOnlineReviews, createProtocolReviewer, finalizeOnlineReviewDocument, finalizeOnlineReviews, findProtocolOnlineReviews, getAvailableCommitteeMembersForCurrentSubmission, getBusinessObjectService, getCommitteeService, getDocumentService, getKraAuthorizationService, getKraDocumentRejectionService, getKraWorkflowService, getPersonService, getProtocolAssignReviewersService, getProtocolOnlineReviewDocument, getProtocolOnlineReviewDocumentDescription, getProtocolReviewDocumentsForCurrentSubmission, getProtocolReviewer, getProtocolReviews, getProtocolReviews, getReviewerApproveNodeName, getReviewerCommentsService, getWorkflowDocumentService, isProtocolReviewer, moveOnlineReviews, removeOnlineReviewDocument, removeOnlineReviews, returnProtocolOnlineReviewDocumentToReviewer, setBusinessObjectService, setCommitteeService, setDocumentService, setIdentityManagementService, setKraAuthorizationService, setKraDocumentRejectionService, setPersonService, setProtocolAssignReviewersService, setProtocolFinderDao, setReviewCommentsService, setReviewerApproveNodeName, setWorkflowDocumentService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kra.protocol.onlinereview.ProtocolOnlineReviewService

cancelOnlineReviews, createProtocolReviewer, finalizeOnlineReviews, getAvailableCommitteeMembersForCurrentSubmission, getProtocolOnlineReviewDocument, getProtocolOnlineReviewDocumentDescription, getProtocolReviewDocumentsForCurrentSubmission, getProtocolReviewer, getProtocolReviews, getProtocolReviews, isProtocolReviewer, moveOnlineReviews, removeOnlineReviews, returnProtocolOnlineReviewDocumentToReviewer

Constructor Detail

IacucProtocolOnlineReviewServiceImpl

public IacucProtocolOnlineReviewServiceImpl()

Method Detail

isProtocolInStateToBeReviewed

public boolean isProtocolInStateToBeReviewed(ProtocolBase protocol)

Description copied from interface: ProtocolOnlineReviewService

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

Specified by:

isProtocolInStateToBeReviewed in interface ProtocolOnlineReviewService

Returns:

setKraWorkflowService

public void setKraWorkflowService(KraWorkflowService kraWorkflowService)

createAndRouteProtocolOnlineReviewDocument

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

Description copied from class: ProtocolOnlineReviewServiceImplBase

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.

Specified by:

createAndRouteProtocolOnlineReviewDocument in interface ProtocolOnlineReviewService

Overrides:

createAndRouteProtocolOnlineReviewDocument in class ProtocolOnlineReviewServiceImplBase

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.

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.

Returns:

The ProtocolReviewDocument that was created.

See Also:

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)

createProtocolOnlineReviewDocument

public 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

Description copied from class: ProtocolOnlineReviewServiceImplBase

Creates a new ProtocolReviewDocument. Handles creating the workflow document, and the underlying ProtocolReview BO linking the protocol, submission, and reviewer.

Specified by:

createProtocolOnlineReviewDocument in interface IacucProtocolOnlineReviewService

Overrides:

createProtocolOnlineReviewDocument in class ProtocolOnlineReviewServiceImplBase

Parameters:

protocolSubmission - The protocol submission

documentDescription - the description for the created document

documentExplanation - the explanation for the created document

principalId - The principalId to use when creating the workflow document. Usually this should be the principal of the user creating the review.

Throws:

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

removeOnlineReviewDocument

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

Description copied from interface: ProtocolOnlineReviewService

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.

Specified by:

removeOnlineReviewDocument in interface ProtocolOnlineReviewService

Overrides:

removeOnlineReviewDocument in class ProtocolOnlineReviewServiceImplBase

See Also:

org.kuali.kra.irb.onlinereview.ProtocolOnlineReviewService#removeOnlineReviewDocument(java.lang.String, boolean, org.kuali.kra.irb.actions.submit.ProtocolSubmissionBase, java.lang.String)

getProtocolOLRSavedStatusCodeHook

protected String getProtocolOLRSavedStatusCodeHook()

Specified by:

getProtocolOLRSavedStatusCodeHook in class ProtocolOnlineReviewServiceImplBase

getProtocolOLRRemovedCancelledStatusCodeHook

protected String getProtocolOLRRemovedCancelledStatusCodeHook()

Specified by:

getProtocolOLRRemovedCancelledStatusCodeHook in class ProtocolOnlineReviewServiceImplBase

getNewProtocolOnlineReviewDocumentInstanceHook

protected ProtocolOnlineReviewDocumentBase getNewProtocolOnlineReviewDocumentInstanceHook()

Specified by:

getNewProtocolOnlineReviewDocumentInstanceHook in class ProtocolOnlineReviewServiceImplBase

getProtocolOLRDocumentTypeHook

protected String getProtocolOLRDocumentTypeHook()

Specified by:

getProtocolOLRDocumentTypeHook in class ProtocolOnlineReviewServiceImplBase

createNewProtocolReviewerInstanceHook

protected ProtocolReviewer createNewProtocolReviewerInstanceHook()

Specified by:

createNewProtocolReviewerInstanceHook in class ProtocolOnlineReviewServiceImplBase

getProtocolOnlineReviewBOClassHook

protected Class<? extends ProtocolOnlineReviewBase> getProtocolOnlineReviewBOClassHook()

Specified by:

getProtocolOnlineReviewBOClassHook in class ProtocolOnlineReviewServiceImplBase

getProtocolSubmissionBOClassHook

protected Class<? extends ProtocolSubmissionBase> getProtocolSubmissionBOClassHook()

Specified by:

getProtocolSubmissionBOClassHook in class ProtocolOnlineReviewServiceImplBase