org.kuali.kra.protocol.actions.genericactions

Interface ProtocolGenericActionService

All Known Subinterfaces:

IacucProtocolGenericActionService, ProtocolGenericActionService

All Known Implementing Classes:

IacucProtocolGenericActionServiceImpl, ProtocolGenericActionServiceImpl, ProtocolGenericActionServiceImplBase

public interface ProtocolGenericActionService

This class...

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.
void	recall(ProtocolBase protocol) Recalls the proposal
void	recordDisapprovedInRoutingActionAndUpdateStatuses(ProtocolBase protocol, org.kuali.rice.kew.actiontaken.ActionTakenValue latestCurrentActionTakenVal) This method will insert the disapproved action into the given protocol's action list using the annotation and date data from the actionTakenVal argument.
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.
ProtocolDocumentBase	versionAfterDisapprovalInRouting(ProtocolBase protocol) Handles the versioning of the protocol following its disapproval in routing.

Method Detail

versionAfterDisapprovalInRouting

ProtocolDocumentBase versionAfterDisapprovalInRouting(ProtocolBase protocol)
                                                      throws Exception

Handles the versioning of the protocol following its disapproval in routing. It will reset the status of the new copy of the protocol to be 'pending/in progress', and change the submission status to 'disapproved'.

Parameters:

protocol - ProtocolBase object

Returns:

the newly versioned ProtocolBase document

Throws:

Exception - if there was a general problem performing the action

recordDisapprovedInRoutingActionAndUpdateStatuses

void recordDisapprovedInRoutingActionAndUpdateStatuses(ProtocolBase protocol,
                                                     org.kuali.rice.kew.actiontaken.ActionTakenValue latestCurrentActionTakenVal)

This method will insert the disapproved action into the given protocol's action list using the annotation and date data from the actionTakenVal argument. It will then update the protocol's status and its submission status to 'disapproved' and save the protocol.

Parameters:

protocol -

actionTakenVal -

disapprove

void disapprove(ProtocolBase protocol,
              ProtocolGenericActionBean actionBean)
                throws Exception

Disapproves a protocol.

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

expire

void expire(ProtocolBase protocol,
          ProtocolGenericActionBean actionBean)
            throws Exception

Expire a protocol.

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

returnForSMR

ProtocolDocumentBase returnForSMR(ProtocolBase protocol,
                                ProtocolGenericActionBean actionBean)
                                  throws Exception

Returns the protocol to the PI for specific minor revisions.

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

ProtocolDocumentBase returnForSRR(ProtocolBase protocol,
                                ProtocolGenericActionBean actionBean)
                                  throws Exception

Returns the protocol to the PI for substantial revisions.

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

ProtocolDocumentBase returnToPI(ProtocolBase protocol,
                              ProtocolGenericActionBean actionBean)
                                throws Exception

Returns the protocol to the PI.

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

void suspend(ProtocolBase protocol,
           ProtocolGenericActionBean actionBean)
             throws Exception

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

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

terminate

void terminate(ProtocolBase protocol,
             ProtocolGenericActionBean actionBean)
               throws Exception

Terminate a protocol.

Parameters:

protocol - ProtocolBase object

actionBean - ProtocolGenericActionBean object

Throws:

Exception - if there was a general problem performing the action

recall

void recall(ProtocolBase protocol)

Recalls the proposal

Parameters:

protocol -

Throws:

Exception