org.kuali.kra.iacuc.actions.genericactions

Class IacucProtocolGenericActionServiceImpl

java.lang.Object

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

org.kuali.kra.iacuc.actions.genericactions.IacucProtocolGenericActionServiceImpl

All Implemented Interfaces:

IacucProtocolGenericActionService, ProtocolGenericActionService

public class IacucProtocolGenericActionServiceImpl
extends ProtocolGenericActionServiceImplBase
implements IacucProtocolGenericActionService

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
IacucProtocolGenericActionServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
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()
void	iacucAcknowledgement(ProtocolBase protocol, ProtocolGenericActionBean actionBean)
void	iacucDeactivate(ProtocolBase protocol, ProtocolGenericActionBean actionBean)
void	iacucHold(ProtocolBase protocol, ProtocolGenericActionBean actionBean)
void	iacucLiftHold(ProtocolBase protocol, ProtocolGenericActionBean actionBean)
ProtocolDocumentBase	returnForSMR(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Returns the protocol to the PI for specific minor revisions.
ProtocolDocumentBase	returnForSRR(ProtocolBase protocol, ProtocolGenericActionBean actionBean) Returns the protocol to the PI for substantial revisions.
ProtocolDocumentBase	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	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, getReturnedVersionedDocument, getVersionedDocument, performDisapprove, 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

IacucProtocolGenericActionServiceImpl

public IacucProtocolGenericActionServiceImpl()

Method Detail

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

returnForSMR

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

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

iacucAcknowledgement

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

Specified by:

iacucAcknowledgement in interface IacucProtocolGenericActionService

Throws:

Exception

iacucHold

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

Specified by:

iacucHold in interface IacucProtocolGenericActionService

Throws:

Exception

iacucLiftHold

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

Specified by:

iacucLiftHold in interface IacucProtocolGenericActionService

Throws:

Exception

iacucDeactivate

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

Specified by:

iacucDeactivate in interface IacucProtocolGenericActionService

Throws:

Exception

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

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