org.kuali.kra.irb.actions.genericactions

Class ProtocolGenericActionServiceImpl

java.lang.Object

org.kuali.kra.protocol.actions.genericactions.ProtocolGenericActionServiceImplBase

org.kuali.kra.irb.actions.genericactions.ProtocolGenericActionServiceImpl

All Implemented Interfaces:

ProtocolGenericActionService

public class ProtocolGenericActionServiceImpl
extends ProtocolGenericActionServiceImplBase
implements ProtocolGenericActionService

This class handles the generic actions that can be made to a protocol. A generic action contain a comment, action date, and a state change.

Constructor Summary

Constructors

Constructor and Description
ProtocolGenericActionServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	close(Protocol protocol, ProtocolGenericActionBean actionBean) Close a protocol.
void	closeEnrollment(Protocol protocol, ProtocolGenericActionBean actionBean) Close enrollment for a protocol.
ProtocolDocument	defer(Protocol protocol, ProtocolGenericActionBean actionBean) Defer a protocol.
void	disapprove(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Disapproves a protocol.
void	expire(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Expire a protocol.
protected String	getDisapprovedProtocolStatusCodeHook()
protected ProtocolActionBase	getNewDisapprovedInRoutingProtocolActionInstanceHook(ProtocolBase protocol)
protected ProtocolActionBase	getNewProtocolActionInstanceHook(ProtocolBase protocol, ProtocolSubmissionBase submission, String protocolActionType)
protected ProtocolActionsCorrespondenceBase	getNewProtocolActionsCorrespondenceHook(String protocolActionType)
protected String	getProtocolPendingInProgressStatusCodeHook()
protected String	getProtocolSubmissionStatusRejectedInRoutingCodeHook()
protected String	getRecallProtocolActionTypeCodeHook()
protected ProtocolDocument	getReturnedVersionedDocument(ProtocolBase protocol)
void	irbAcknowledgement(Protocol protocol, ProtocolGenericActionBean actionBean) Record IRB Acknowledgement for a protocol.
protected void	performDisapprove(ProtocolBase protocol)
void	permitDataAnalysis(Protocol protocol, ProtocolGenericActionBean actionBean) Permit Data Analysis.
void	reopenEnrollment(Protocol protocol, ProtocolGenericActionBean actionBean) Reopen a protocol for enrollment.
ProtocolDocument	returnForSMR(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Returns the protocol to the PI for specific minor revisions.
ProtocolDocument	returnForSRR(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Returns the protocol to the PI for substantial revisions.
ProtocolDocument	returnToPI(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Returns the protocol to the PI.
void	suspend(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Suspend the protocol by the PI or by the IRB Administrator.
void	suspendByDsmb(Protocol protocol, ProtocolGenericActionBean actionBean) Suspend the protocol by DSMB.
void	terminate(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Terminate a protocol.

Methods inherited from class org.kuali.kra.protocol.actions.genericactions.ProtocolGenericActionServiceImplBase

createCorrespondenceAndAttach, createProtocolActionAndAttach, getBusinessObjectService, getDocumentService, getKcNotificationService, getProtocolActionCorrespondenceGenerationService, getProtocolActionService, getProtocolAssignToAgendaService, getProtocolOnlineReviewService, getProtocolVersionService, getVersionedDocument, performGenericAction, recall, recordDisapprovedInRoutingActionAndUpdateStatuses, setBusinessObjectService, setDocumentService, setKcNotificationService, setProtocolActionCorrespondenceGenerationService, setProtocolActionService, setProtocolAssignToAgendaService, setProtocolOnlineReviewService, setProtocolVersionService, versionAfterDisapprovalInRouting

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.actions.genericactions.ProtocolGenericActionService

recall, recordDisapprovedInRoutingActionAndUpdateStatuses, versionAfterDisapprovalInRouting

Constructor Detail

ProtocolGenericActionServiceImpl

public ProtocolGenericActionServiceImpl()

Method Detail

close

public void close(Protocol protocol,
         ProtocolGenericActionBean actionBean)
           throws Exception

Close a protocol.

Parameters:

protocol - Protocol object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

closeEnrollment

public void closeEnrollment(Protocol protocol,
                   ProtocolGenericActionBean actionBean)
                     throws Exception

Close enrollment for a protocol.

Parameters:

protocol - Protocol object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

defer

public ProtocolDocument defer(Protocol protocol,
                     ProtocolGenericActionBean actionBean)
                       throws Exception

Defer a protocol.

Parameters:

protocol - Protocol object

actionBean - ProtocolGenericActionBean object

Returns:

the newly versioned Protocol document

Throws:

Exception - if there was a general problem performing the action

disapprove

public void disapprove(ProtocolBase protocol,
              ProtocolGenericActionBean actionBean)
                throws Exception

Disapproves a protocol.

Specified by:

disapprove in interface ProtocolGenericActionService

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

expire

public void expire(ProtocolBase protocol,
          ProtocolGenericActionBean actionBean)
            throws Exception

Expire a protocol.

Specified by:

expire in interface ProtocolGenericActionService

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

irbAcknowledgement

public void irbAcknowledgement(Protocol protocol,
                      ProtocolGenericActionBean actionBean)
                        throws Exception

Record IRB Acknowledgement for a protocol.

Parameters:

protocol - Protocol object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

permitDataAnalysis

public void permitDataAnalysis(Protocol protocol,
                      ProtocolGenericActionBean actionBean)
                        throws Exception

Permit Data Analysis.

Parameters:

protocol - Protocol object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

reopenEnrollment

public void reopenEnrollment(Protocol protocol,
                    ProtocolGenericActionBean actionBean)
                      throws Exception

Reopen a protocol for enrollment.

Parameters:

protocol - Protocol object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

returnForSMR

public ProtocolDocument returnForSMR(ProtocolBase protocol,
                            ProtocolGenericActionBean actionBean)
                              throws Exception

Returns the protocol to the PI for specific minor revisions.

Specified by:

returnForSMR in interface ProtocolGenericActionService

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Returns:

the newly versioned ProtocolBase document

Throws:

Exception - if there was a general problem performing the action

returnForSRR

public ProtocolDocument returnForSRR(ProtocolBase protocol,
                            ProtocolGenericActionBean actionBean)
                              throws Exception

Returns the protocol to the PI for substantial revisions.

Specified by:

returnForSRR in interface ProtocolGenericActionService

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Returns:

the newly versioned ProtocolBase document

Throws:

Exception - if there was a general problem performing the action

returnToPI

public ProtocolDocument returnToPI(ProtocolBase protocol,
                          ProtocolGenericActionBean actionBean)
                            throws Exception

Returns the protocol to the PI.

Specified by:

returnToPI in interface ProtocolGenericActionService

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Returns:

the newly versioned ProtocolBase document

Throws:

Exception - if there was a general problem performing the action

suspend

public void suspend(ProtocolBase protocol,
           ProtocolGenericActionBean actionBean)
             throws Exception

Suspend the protocol by the PI or by the IRB Administrator.

Specified by:

suspend in interface ProtocolGenericActionService

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

suspendByDsmb

public void suspendByDsmb(Protocol protocol,
                 ProtocolGenericActionBean actionBean)
                   throws Exception

Suspend the protocol by DSMB.

Parameters:

protocol - Protocol object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

terminate

public void terminate(ProtocolBase protocol,
             ProtocolGenericActionBean actionBean)
               throws Exception

Terminate a protocol.

Specified by:

terminate in interface ProtocolGenericActionService

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

getNewProtocolActionInstanceHook

protected ProtocolActionBase getNewProtocolActionInstanceHook(ProtocolBase protocol,
                                                  ProtocolSubmissionBase submission,
                                                  String protocolActionType)

Specified by:

getNewProtocolActionInstanceHook in class ProtocolGenericActionServiceImplBase

getNewProtocolActionsCorrespondenceHook

protected ProtocolActionsCorrespondenceBase getNewProtocolActionsCorrespondenceHook(String protocolActionType)

Specified by:

getNewProtocolActionsCorrespondenceHook in class ProtocolGenericActionServiceImplBase

performDisapprove

protected void performDisapprove(ProtocolBase protocol)
                          throws Exception

Overrides:

performDisapprove in class ProtocolGenericActionServiceImplBase

Throws:

Exception

getReturnedVersionedDocument

protected ProtocolDocument getReturnedVersionedDocument(ProtocolBase protocol)
                                                 throws Exception

Overrides:

getReturnedVersionedDocument in class ProtocolGenericActionServiceImplBase

Throws:

Exception

getProtocolPendingInProgressStatusCodeHook

protected String getProtocolPendingInProgressStatusCodeHook()

Specified by:

getProtocolPendingInProgressStatusCodeHook in class ProtocolGenericActionServiceImplBase

getProtocolSubmissionStatusRejectedInRoutingCodeHook

protected String getProtocolSubmissionStatusRejectedInRoutingCodeHook()

Specified by:

getProtocolSubmissionStatusRejectedInRoutingCodeHook in class ProtocolGenericActionServiceImplBase

getNewDisapprovedInRoutingProtocolActionInstanceHook

protected ProtocolActionBase getNewDisapprovedInRoutingProtocolActionInstanceHook(ProtocolBase protocol)

Specified by:

getNewDisapprovedInRoutingProtocolActionInstanceHook in class ProtocolGenericActionServiceImplBase

getDisapprovedProtocolStatusCodeHook

protected String getDisapprovedProtocolStatusCodeHook()

Specified by:

getDisapprovedProtocolStatusCodeHook in class ProtocolGenericActionServiceImplBase

getRecallProtocolActionTypeCodeHook

protected String getRecallProtocolActionTypeCodeHook()

Specified by:

getRecallProtocolActionTypeCodeHook in class ProtocolGenericActionServiceImplBase