org.kuali.kra.irb.onlinereview

Class ProtocolOnlineReviewAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DispatchAction

org.kuali.rice.kns.web.struts.action.KualiAction

org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

org.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase

org.kuali.kra.protocol.ProtocolActionBase

org.kuali.kra.irb.ProtocolAction

org.kuali.kra.irb.onlinereview.ProtocolOnlineReviewAction

All Implemented Interfaces:

org.kuali.rice.kns.web.struts.action.AuditModeAction

public class ProtocolOnlineReviewAction
extends ProtocolAction
implements org.kuali.rice.kns.web.struts.action.AuditModeAction

The set of actions for the Protocol Actions tab.

Field Summary

Fields inherited from class org.kuali.kra.irb.ProtocolAction

PROTOCOL_ACTIONS_HOOK, PROTOCOL_CUSTOM_DATA_HOOK, PROTOCOL_MEDUSA, PROTOCOL_NAME_HOOK, PROTOCOL_NOTE_ATTACHMENT_HOOK, PROTOCOL_ONLINE_REVIEW_HOOK, PROTOCOL_PERMISSIONS_HOOK, PROTOCOL_PERSONNEL_HOOK, PROTOCOL_QUESTIONNAIRE_HOOK, PROTOCOL_SPECIAL_REVIEW_HOOK

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

DOCUMENT_LOAD_COMMANDS

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

FORM_ACTION, FORWARD_NEXT, FORWARD_TEXT_AREA_UPDATE, METHOD_TO_CALL, POST_TEXT_AREA_TO_PARENT, TEXT_AREA_FIELD_ANCHOR, TEXT_AREA_FIELD_LABEL, TEXT_AREA_FIELD_NAME, TEXT_AREA_MAX_LENGTH, TEXT_AREA_READ_ONLY

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, methods, types

Fields inherited from class org.apache.struts.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
ProtocolOnlineReviewAction()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	activate(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	addOnlineReviewAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is for action to add OLR review attachment
org.apache.struts.action.ActionForward	addOnlineReviewComment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	approveOnlineReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	blanketApproveOnlineReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	cancelOnlineReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	createOnlineReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	deactivate(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	deleteOnlineReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	deleteOnlineReviewAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is to delete the OLR review attachment and persist it
org.apache.struts.action.ActionForward	deleteOnlineReviewComment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected org.kuali.rice.krad.service.KualiRuleService	getKualiRuleService() Get the Kuali Rule Service.
protected String	getOnlineReviewActionDocumentNumber(String parameterName, String actionMethodToCall) The online review actions are encoded into the methodToCall parameters using: (actionMethodToCall).(onlineReviewDocumentNumber).anchor in the name attributes of the online review form buttons.
protected int	getOnlineReviewActionIndexNumber(String parameterName, String actionMethodToCall)
org.apache.struts.action.ActionForward	moveDownOnlineReviewComment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	moveUpOnlineReviewComment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	recordOnlineReviewActionSuccess(String onlineReviewActionName, ProtocolOnlineReviewDocument document)
org.apache.struts.action.ActionForward	refreshPage(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Refreshes the page.
org.apache.struts.action.ActionForward	rejectOnlineReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	saveOnlineReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	startProtocolOnlineReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is to render protocol review page.
org.apache.struts.action.ActionForward	viewOnlineReviewAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is for 'view' OLR review attachment

Methods inherited from class org.kuali.kra.irb.ProtocolAction

createNewModifyProtocolTaskInstanceHook, customData, docHandler, getCustomDataForwardNameHook, getNoteAndAttachmentForwardNameHook, getPersonnelForwardNameHook, getProtocolActionsForwardNameHook, getProtocolActionsMappingNameHoook, getProtocolForwardNameHook, getProtocolInitialSaveNotificationContextHook, getProtocolNotificationEditorHook, getProtocolNotificationHook, getProtocolOnlineReviewForwardNameHook, getProtocolOnlineReviewMappingNameHoook, getProtocolOnlineReviewService, getProtocolPermissionsForwardNameHook, getProtocolPersonnelService, getProtocolPersonTrainingService, getQuestionnaireForwardNameHook, getQuestionnairePrintingService, getSpecialReviewForwardNameHook, getSubmissionBean, initialDocumentSaveAddRolesHook, medusa, printSubmissionQuestionnaireAnswer, sendNotification

Methods inherited from class org.kuali.kra.protocol.ProtocolActionBase

applyRules, applyRules, branchToPanelOrNotificationEditor, buildForwardUrl, getKraAuthorizationService, getNotificationService, getSubmitActionType, getUnitAclLoadService, getUnitRulesMessages, initialDocumentSave, isInitialSave, noteAndAttachment, onlineReview, permissions, personnel, postSave, preSave, printQuestionnaireAnswer, processMultipleLookupResults, protocol, protocolActions, questionnaire, recall, refresh, save, saveOnClose, specialReview, updateAnswerToNewVersion

Methods inherited from class org.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase

buildActionUrl, buildParameterizedConfirmationQuestion, close, confirm, createSuccessfulSubmitRedirect, dispatchMethod, generatePessimisticLockMessage, getValidHeaderString, headerTab, isAuthorized, loadDocument, performQuestionWithoutInput, populateAuthorizationFields, postDocumentSave, preDocumentSave, processAuthorizationViolation, releaseLocks, reload, reloadWithoutWarning, returnToSender, route, routeToHoldingPage, routeToHoldingPage, sendAdHocRequests, setupPessimisticLockMessages, streamToResponse

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

copy

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

acknowledge, approve, attemptLockRelease, blanketApprove, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, combineAdHocRecipients, complete, convertSetToMap, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refreshAdHocRoutingWorkgroupLookups, selectedAttachmentIndex, sendNoteWorkflowNotification, setupDocumentExit, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions, toggleTab

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

addMethodToCallToUncheckedList, defaultDispatch, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, updateTextArea, validateLookupInquiryFullParameter

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolOnlineReviewAction

public ProtocolOnlineReviewAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                             org.apache.struts.action.ActionForm form,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Description copied from class: ProtocolActionBase

Overrides:

execute in class ProtocolActionBase

Throws:

Exception

activate

public org.apache.struts.action.ActionForward activate(org.apache.struts.action.ActionMapping mapping,
                                              org.apache.struts.action.ActionForm form,
                                              javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)
                                                throws Exception

Specified by:

activate in interface org.kuali.rice.kns.web.struts.action.AuditModeAction

Throws:

Exception

deactivate

public org.apache.struts.action.ActionForward deactivate(org.apache.struts.action.ActionMapping mapping,
                                                org.apache.struts.action.ActionForm form,
                                                javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
                                                  throws Exception

Specified by:

deactivate in interface org.kuali.rice.kns.web.struts.action.AuditModeAction

Throws:

Exception

refreshPage

public org.apache.struts.action.ActionForward refreshPage(org.apache.struts.action.ActionMapping mapping,
                                                 org.apache.struts.action.ActionForm form,
                                                 javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response)
                                                   throws Exception

Refreshes the page. We only need to redraw the page. This method is used when JavaScript is disabled. During a review submission action, the user will have to refresh the page. For example, after a committee is selected, the page needs to be refreshed so that the available scheduled dates for that committee can be displayed in the drop-down menu for the scheduled dates. Please see ProtocolSubmitAction.prepareView() for how the Submit for Review works on a refresh.

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

getKualiRuleService

protected org.kuali.rice.krad.service.KualiRuleService getKualiRuleService()

Get the Kuali Rule Service.

Overrides:

getKualiRuleService in class ProtocolActionBase

Returns:

the Kuali Rule Service

createOnlineReview

public org.apache.struts.action.ActionForward createOnlineReview(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
                                                          throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

getOnlineReviewActionDocumentNumber

protected String getOnlineReviewActionDocumentNumber(String parameterName,
                                         String actionMethodToCall)

The online review actions are encoded into the methodToCall parameters using: (actionMethodToCall).(onlineReviewDocumentNumber).anchor in the name attributes of the online review form buttons. Where actionMethodToCall is for example 'routeOnlineReview' onlineReviewDocumentNumber: is the document number of the online review

Parameters:

parameterName - The parameter being decoded, usually retrieved from the request parameters as KNSConstants.METHOD_TO_CALL_ATTRIBUTE.

actionMethodToCall - The methodToCall ( function name in the action being executed. ).

Returns:

getOnlineReviewActionIndexNumber

protected int getOnlineReviewActionIndexNumber(String parameterName,
                                   String actionMethodToCall)

startProtocolOnlineReview

public org.apache.struts.action.ActionForward startProtocolOnlineReview(org.apache.struts.action.ActionMapping mapping,
                                                               org.apache.struts.action.ActionForm form,
                                                               javax.servlet.http.HttpServletRequest request,
                                                               javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

This method is to render protocol review page. It is redirected to by the protocol online review redirect action when the edit link is clicked on in the action list.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

approveOnlineReview

public org.apache.struts.action.ActionForward approveOnlineReview(org.apache.struts.action.ActionMapping mapping,
                                                         org.apache.struts.action.ActionForm form,
                                                         javax.servlet.http.HttpServletRequest request,
                                                         javax.servlet.http.HttpServletResponse response)
                                                           throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

blanketApproveOnlineReview

public org.apache.struts.action.ActionForward blanketApproveOnlineReview(org.apache.struts.action.ActionMapping mapping,
                                                                org.apache.struts.action.ActionForm form,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response)
                                                                  throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

saveOnlineReview

public org.apache.struts.action.ActionForward saveOnlineReview(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                                        throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

rejectOnlineReview

public org.apache.struts.action.ActionForward rejectOnlineReview(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
                                                          throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

deleteOnlineReview

public org.apache.struts.action.ActionForward deleteOnlineReview(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
                                                          throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - if something bad happens

cancelOnlineReview

public org.apache.struts.action.ActionForward cancelOnlineReview(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response)
                                                          throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

addOnlineReviewComment

public org.apache.struts.action.ActionForward addOnlineReviewComment(org.apache.struts.action.ActionMapping mapping,
                                                            org.apache.struts.action.ActionForm form,
                                                            javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response)
                                                              throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

addOnlineReviewAttachment

public org.apache.struts.action.ActionForward addOnlineReviewAttachment(org.apache.struts.action.ActionMapping mapping,
                                                               org.apache.struts.action.ActionForm form,
                                                               javax.servlet.http.HttpServletRequest request,
                                                               javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

This method is for action to add OLR review attachment

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

moveUpOnlineReviewComment

public org.apache.struts.action.ActionForward moveUpOnlineReviewComment(org.apache.struts.action.ActionMapping mapping,
                                                               org.apache.struts.action.ActionForm form,
                                                               javax.servlet.http.HttpServletRequest request,
                                                               javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

moveDownOnlineReviewComment

public org.apache.struts.action.ActionForward moveDownOnlineReviewComment(org.apache.struts.action.ActionMapping mapping,
                                                                 org.apache.struts.action.ActionForm form,
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 javax.servlet.http.HttpServletResponse response)
                                                                   throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

deleteOnlineReviewComment

public org.apache.struts.action.ActionForward deleteOnlineReviewComment(org.apache.struts.action.ActionMapping mapping,
                                                               org.apache.struts.action.ActionForm form,
                                                               javax.servlet.http.HttpServletRequest request,
                                                               javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

Parameters:

mapping - the mapping associated with this action.

form - the Protocol form.

request - the HTTP request

response - the HTTP response

Returns:

the name of the HTML page to display

Throws:

Exception - doesn't ever really happen

deleteOnlineReviewAttachment

public org.apache.struts.action.ActionForward deleteOnlineReviewAttachment(org.apache.struts.action.ActionMapping mapping,
                                                                  org.apache.struts.action.ActionForm form,
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                                    throws Exception

This method is to delete the OLR review attachment and persist it

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

recordOnlineReviewActionSuccess

protected void recordOnlineReviewActionSuccess(String onlineReviewActionName,
                                   ProtocolOnlineReviewDocument document)

viewOnlineReviewAttachment

public org.apache.struts.action.ActionForward viewOnlineReviewAttachment(org.apache.struts.action.ActionMapping mapping,
                                                                org.apache.struts.action.ActionForm form,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response)
                                                                  throws Exception

This method is for 'view' OLR review attachment

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception