org.kuali.kra.protocol.actions.genericactions

Class ProtocolGenericActionServiceImplBase

java.lang.Object

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

All Implemented Interfaces:

ProtocolGenericActionService

Direct Known Subclasses:

IacucProtocolGenericActionServiceImpl, ProtocolGenericActionServiceImpl

public abstract class ProtocolGenericActionServiceImplBase
extends Object
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
ProtocolGenericActionServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createCorrespondenceAndAttach(ProtocolBase protocol, String protocolActionType)
protected ProtocolActionBase	createProtocolActionAndAttach(ProtocolBase protocol, ProtocolGenericActionBean actionBean, String protocolActionType)
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected abstract String	getDisapprovedProtocolStatusCodeHook()
protected org.kuali.rice.krad.service.DocumentService	getDocumentService()
protected KcNotificationService	getKcNotificationService()
protected abstract ProtocolActionBase	getNewDisapprovedInRoutingProtocolActionInstanceHook(ProtocolBase protocol)
protected abstract ProtocolActionBase	getNewProtocolActionInstanceHook(ProtocolBase protocol, ProtocolSubmissionBase submission, String protocolActionType)
protected abstract ProtocolActionsCorrespondenceBase	getNewProtocolActionsCorrespondenceHook(String protocolActionType)
protected ProtocolActionCorrespondenceGenerationService	getProtocolActionCorrespondenceGenerationService()
protected ProtocolActionService	getProtocolActionService()
protected ProtocolAssignToAgendaService	getProtocolAssignToAgendaService()
protected ProtocolOnlineReviewService	getProtocolOnlineReviewService()
protected abstract String	getProtocolPendingInProgressStatusCodeHook()
protected abstract String	getProtocolSubmissionStatusRejectedInRoutingCodeHook()
protected ProtocolVersionService	getProtocolVersionService()
protected abstract String	getRecallProtocolActionTypeCodeHook()
protected ProtocolDocumentBase	getReturnedVersionedDocument(ProtocolBase protocol)
protected ProtocolDocumentBase	getVersionedDocument(ProtocolBase protocol)
protected void	performDisapprove(ProtocolBase protocol)
protected void	performGenericAction(ProtocolBase protocol, ProtocolGenericActionBean actionBean, String protocolActionType, String newProtocolStatus) Performs the generic action, which includes a state change, action date, and a comment, that's it!
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.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setKcNotificationService(KcNotificationService kcNotificationService)
void	setProtocolActionCorrespondenceGenerationService(ProtocolActionCorrespondenceGenerationService protocolActionCorrespondenceGenerationService)
void	setProtocolActionService(ProtocolActionService protocolActionService)
void	setProtocolAssignToAgendaService(ProtocolAssignToAgendaService protocolAssignToAgendaService)
void	setProtocolOnlineReviewService(ProtocolOnlineReviewService protocolOnlineReviewService)
void	setProtocolVersionService(ProtocolVersionService protocolVersionService)
ProtocolDocumentBase	versionAfterDisapprovalInRouting(ProtocolBase oldProtocol) Handles the versioning of the protocol following its disapproval in routing.

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

disapprove, expire, returnForSMR, returnForSRR, returnToPI, suspend, terminate

Constructor Detail

ProtocolGenericActionServiceImplBase

public ProtocolGenericActionServiceImplBase()

Method Detail

performGenericAction

protected void performGenericAction(ProtocolBase protocol,
                        ProtocolGenericActionBean actionBean,
                        String protocolActionType,
                        String newProtocolStatus)
                             throws Exception

Performs the generic action, which includes a state change, action date, and a comment, that's it!

Parameters:

protocol -

actionBean -

protocolActionType -

newProtocolStatus -

Throws:

Exception

createProtocolActionAndAttach

protected ProtocolActionBase createProtocolActionAndAttach(ProtocolBase protocol,
                                               ProtocolGenericActionBean actionBean,
                                               String protocolActionType)

getNewProtocolActionInstanceHook

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

getNewProtocolActionsCorrespondenceHook

protected abstract ProtocolActionsCorrespondenceBase getNewProtocolActionsCorrespondenceHook(String protocolActionType)

createCorrespondenceAndAttach

protected void createCorrespondenceAndAttach(ProtocolBase protocol,
                                 String protocolActionType)
                                      throws PrintingException

Throws:

PrintingException

performDisapprove

protected void performDisapprove(ProtocolBase protocol)
                          throws Exception

Throws:

Exception

getReturnedVersionedDocument

protected ProtocolDocumentBase getReturnedVersionedDocument(ProtocolBase protocol)
                                                     throws Exception

Throws:

Exception

recordDisapprovedInRoutingActionAndUpdateStatuses

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

Description copied from interface: ProtocolGenericActionService

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.

Specified by:

recordDisapprovedInRoutingActionAndUpdateStatuses in interface ProtocolGenericActionService

getProtocolSubmissionStatusRejectedInRoutingCodeHook

protected abstract String getProtocolSubmissionStatusRejectedInRoutingCodeHook()

getDisapprovedProtocolStatusCodeHook

protected abstract String getDisapprovedProtocolStatusCodeHook()

getNewDisapprovedInRoutingProtocolActionInstanceHook

protected abstract ProtocolActionBase getNewDisapprovedInRoutingProtocolActionInstanceHook(ProtocolBase protocol)

versionAfterDisapprovalInRouting

public ProtocolDocumentBase versionAfterDisapprovalInRouting(ProtocolBase oldProtocol)
                                                      throws Exception

Description copied from interface: ProtocolGenericActionService

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'.

Specified by:

versionAfterDisapprovalInRouting in interface ProtocolGenericActionService

Parameters:

oldProtocol - ProtocolBase object

Returns:

the newly versioned ProtocolBase document

Throws:

Exception - if there was a general problem performing the action

getProtocolPendingInProgressStatusCodeHook

protected abstract String getProtocolPendingInProgressStatusCodeHook()

getVersionedDocument

protected ProtocolDocumentBase getVersionedDocument(ProtocolBase protocol)
                                             throws Exception

Throws:

Exception

getRecallProtocolActionTypeCodeHook

protected abstract String getRecallProtocolActionTypeCodeHook()

recall

public void recall(ProtocolBase protocol)

Description copied from interface: ProtocolGenericActionService

Recalls the proposal

Specified by:

recall in interface ProtocolGenericActionService

setProtocolActionService

public void setProtocolActionService(ProtocolActionService protocolActionService)

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

setProtocolActionCorrespondenceGenerationService

public void setProtocolActionCorrespondenceGenerationService(ProtocolActionCorrespondenceGenerationService protocolActionCorrespondenceGenerationService)

setProtocolOnlineReviewService

public void setProtocolOnlineReviewService(ProtocolOnlineReviewService protocolOnlineReviewService)

setProtocolVersionService

public void setProtocolVersionService(ProtocolVersionService protocolVersionService)

setProtocolAssignToAgendaService

public void setProtocolAssignToAgendaService(ProtocolAssignToAgendaService protocolAssignToAgendaService)

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

setKcNotificationService

public void setKcNotificationService(KcNotificationService kcNotificationService)

getProtocolActionService

protected ProtocolActionService getProtocolActionService()

getDocumentService

protected org.kuali.rice.krad.service.DocumentService getDocumentService()

getProtocolActionCorrespondenceGenerationService

protected ProtocolActionCorrespondenceGenerationService getProtocolActionCorrespondenceGenerationService()

getProtocolOnlineReviewService

protected ProtocolOnlineReviewService getProtocolOnlineReviewService()

getProtocolVersionService

protected ProtocolVersionService getProtocolVersionService()

getProtocolAssignToAgendaService

protected ProtocolAssignToAgendaService getProtocolAssignToAgendaService()

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

getKcNotificationService

protected KcNotificationService getKcNotificationService()