org.kuali.kra.irb

Class ProtocolAction

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

Direct Known Subclasses:

ProtocolCustomDataAction, ProtocolMedusaAction, ProtocolNoteAndAttachmentAction, ProtocolNotificationEditorAction, ProtocolOnlineReviewAction, ProtocolPermissionsAction, ProtocolPersonnelAction, ProtocolProtocolAction, ProtocolProtocolActionsAction, ProtocolQuestionnaireAction, ProtocolSpecialReviewAction

public abstract class ProtocolAction
extends ProtocolActionBase

The ProtocolAction is the base class for all Protocol actions. Each derived Action class corresponds to one tab (web page). The derived Action class handles all user requests for that particular tab (web page).

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROTOCOL_ACTIONS_HOOK
static String	PROTOCOL_CUSTOM_DATA_HOOK
static String	PROTOCOL_MEDUSA
static String	PROTOCOL_NAME_HOOK
static String	PROTOCOL_NOTE_ATTACHMENT_HOOK
static String	PROTOCOL_ONLINE_REVIEW_HOOK
static String	PROTOCOL_PERMISSIONS_HOOK
static String	PROTOCOL_PERSONNEL_HOOK
static String	PROTOCOL_QUESTIONNAIRE_HOOK
static String	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
ProtocolAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected ProtocolTaskBase	createNewModifyProtocolTaskInstanceHook(ProtocolBase protocol)
org.apache.struts.action.ActionForward	customData(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	docHandler(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected String	getCustomDataForwardNameHook()
protected String	getNoteAndAttachmentForwardNameHook()
protected String	getPersonnelForwardNameHook()
protected String	getProtocolActionsForwardNameHook()
protected String	getProtocolActionsMappingNameHoook()
protected String	getProtocolForwardNameHook()
protected ProtocolNotificationContextBase	getProtocolInitialSaveNotificationContextHook(ProtocolBase protocol)
protected String	getProtocolNotificationEditorHook()
protected ProtocolNotification	getProtocolNotificationHook()
protected String	getProtocolOnlineReviewForwardNameHook()
protected String	getProtocolOnlineReviewMappingNameHoook()
protected ProtocolOnlineReviewService	getProtocolOnlineReviewService()
protected String	getProtocolPermissionsForwardNameHook()
protected ProtocolPersonnelService	getProtocolPersonnelService() This method is to get protocol personnel service
protected ProtocolPersonTrainingService	getProtocolPersonTrainingService() This method is to get protocol personnel training service
protected String	getQuestionnaireForwardNameHook()
protected QuestionnairePrintingService	getQuestionnairePrintingService()
protected String	getSpecialReviewForwardNameHook()
protected ProtocolSubmissionBeanBase	getSubmissionBean(org.apache.struts.action.ActionForm form, String submissionActionType)
protected void	initialDocumentSaveAddRolesHook(String userId, ProtocolBase protocol) This method is used in conjunction with initialDocumentSave to populuate the appropriate roles for the given protocl (iacuc or irb).
org.apache.struts.action.ActionForward	medusa(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	printSubmissionQuestionnaireAnswer(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 print submission questionnaire answer
protected void	sendNotification(ProtocolFormBase protocolForm)

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

applyRules, applyRules, branchToPanelOrNotificationEditor, buildForwardUrl, execute, getKraAuthorizationService, getKualiRuleService, 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

Field Detail

PROTOCOL_NAME_HOOK

public static final String PROTOCOL_NAME_HOOK

See Also:

Constant Field Values

PROTOCOL_QUESTIONNAIRE_HOOK

public static final String PROTOCOL_QUESTIONNAIRE_HOOK

See Also:

Constant Field Values

PROTOCOL_PERSONNEL_HOOK

public static final String PROTOCOL_PERSONNEL_HOOK

See Also:

Constant Field Values

PROTOCOL_SPECIAL_REVIEW_HOOK

public static final String PROTOCOL_SPECIAL_REVIEW_HOOK

See Also:

Constant Field Values

PROTOCOL_NOTE_ATTACHMENT_HOOK

public static final String PROTOCOL_NOTE_ATTACHMENT_HOOK

See Also:

Constant Field Values

PROTOCOL_ACTIONS_HOOK

public static final String PROTOCOL_ACTIONS_HOOK

See Also:

Constant Field Values

PROTOCOL_ONLINE_REVIEW_HOOK

public static final String PROTOCOL_ONLINE_REVIEW_HOOK

See Also:

Constant Field Values

PROTOCOL_PERMISSIONS_HOOK

public static final String PROTOCOL_PERMISSIONS_HOOK

See Also:

Constant Field Values

PROTOCOL_CUSTOM_DATA_HOOK

public static final String PROTOCOL_CUSTOM_DATA_HOOK

See Also:

Constant Field Values

PROTOCOL_MEDUSA

public static final String PROTOCOL_MEDUSA

See Also:

Constant Field Values

Constructor Detail

ProtocolAction

public ProtocolAction()

Method Detail

getSubmissionBean

protected ProtocolSubmissionBeanBase getSubmissionBean(org.apache.struts.action.ActionForm form,
                                           String submissionActionType)

Overrides:

getSubmissionBean in class ProtocolActionBase

customData

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

Overrides:

customData in class ProtocolActionBase

medusa

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

Throws:

Exception

docHandler

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

Overrides:

docHandler in class ProtocolActionBase

Throws:

Exception

See Also:

org.kuali.core.web.struts.action.KualiDocumentActionBase#docHandler(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getProtocolPersonTrainingService

protected ProtocolPersonTrainingService getProtocolPersonTrainingService()

This method is to get protocol personnel training service

Specified by:

getProtocolPersonTrainingService in class ProtocolActionBase

Returns:

ProtocolPersonTrainingService

getProtocolPersonnelService

protected ProtocolPersonnelService getProtocolPersonnelService()

This method is to get protocol personnel service

Specified by:

getProtocolPersonnelService in class ProtocolActionBase

Returns:

ProtocolPersonnelService

getProtocolOnlineReviewService

protected ProtocolOnlineReviewService getProtocolOnlineReviewService()

printSubmissionQuestionnaireAnswer

public org.apache.struts.action.ActionForward printSubmissionQuestionnaireAnswer(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 print submission questionnaire answer

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getQuestionnairePrintingService

protected QuestionnairePrintingService getQuestionnairePrintingService()

Overrides:

getQuestionnairePrintingService in class ProtocolActionBase

sendNotification

protected void sendNotification(ProtocolFormBase protocolForm)

Specified by:

sendNotification in class ProtocolActionBase

getProtocolForwardNameHook

protected String getProtocolForwardNameHook()

Specified by:

getProtocolForwardNameHook in class ProtocolActionBase

getQuestionnaireForwardNameHook

protected String getQuestionnaireForwardNameHook()

Specified by:

getQuestionnaireForwardNameHook in class ProtocolActionBase

getPersonnelForwardNameHook

protected String getPersonnelForwardNameHook()

Specified by:

getPersonnelForwardNameHook in class ProtocolActionBase

getNoteAndAttachmentForwardNameHook

protected String getNoteAndAttachmentForwardNameHook()

Specified by:

getNoteAndAttachmentForwardNameHook in class ProtocolActionBase

getProtocolActionsForwardNameHook

protected String getProtocolActionsForwardNameHook()

Specified by:

getProtocolActionsForwardNameHook in class ProtocolActionBase

getProtocolOnlineReviewForwardNameHook

protected String getProtocolOnlineReviewForwardNameHook()

Specified by:

getProtocolOnlineReviewForwardNameHook in class ProtocolActionBase

getProtocolPermissionsForwardNameHook

protected String getProtocolPermissionsForwardNameHook()

Specified by:

getProtocolPermissionsForwardNameHook in class ProtocolActionBase

getSpecialReviewForwardNameHook

protected String getSpecialReviewForwardNameHook()

Specified by:

getSpecialReviewForwardNameHook in class ProtocolActionBase

getCustomDataForwardNameHook

protected String getCustomDataForwardNameHook()

Specified by:

getCustomDataForwardNameHook in class ProtocolActionBase

getProtocolNotificationHook

protected ProtocolNotification getProtocolNotificationHook()

Specified by:

getProtocolNotificationHook in class ProtocolActionBase

createNewModifyProtocolTaskInstanceHook

protected ProtocolTaskBase createNewModifyProtocolTaskInstanceHook(ProtocolBase protocol)

Specified by:

createNewModifyProtocolTaskInstanceHook in class ProtocolActionBase

initialDocumentSaveAddRolesHook

protected void initialDocumentSaveAddRolesHook(String userId,
                                   ProtocolBase protocol)

Description copied from class: ProtocolActionBase

This method is used in conjunction with initialDocumentSave to populuate the appropriate roles for the given protocl (iacuc or irb).

Specified by:

initialDocumentSaveAddRolesHook in class ProtocolActionBase

getProtocolOnlineReviewMappingNameHoook

protected String getProtocolOnlineReviewMappingNameHoook()

Specified by:

getProtocolOnlineReviewMappingNameHoook in class ProtocolActionBase

getProtocolActionsMappingNameHoook

protected String getProtocolActionsMappingNameHoook()

Specified by:

getProtocolActionsMappingNameHoook in class ProtocolActionBase

getProtocolNotificationEditorHook

protected String getProtocolNotificationEditorHook()

Specified by:

getProtocolNotificationEditorHook in class ProtocolActionBase

getProtocolInitialSaveNotificationContextHook

protected ProtocolNotificationContextBase getProtocolInitialSaveNotificationContextHook(ProtocolBase protocol)

Specified by:

getProtocolInitialSaveNotificationContextHook in class ProtocolActionBase