org.kuali.kra.irb.permission

Class ProtocolPermissionsAction

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.permission.ProtocolPermissionsAction

All Implemented Interfaces:

PermissionsAction

public class ProtocolPermissionsAction
extends ProtocolAction
implements PermissionsAction

The ProtocolPermissionsAction responds to user events from the Permissions web page.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addUser(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Add a new Protocol User to the list of users who can access a protocol.
org.apache.struts.action.ActionForward	confirmDeletePermissionsUser(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) If the the end-user confirms that a user must be deleted from the list of protocol users, then do so.
org.apache.struts.action.ActionForward	deleteUser(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete a Protocol User from the list of users who can access a protocol.
org.apache.struts.action.ActionForward	editRoles(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Display the Edit Roles HTML web page.
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)
org.apache.struts.action.ActionForward	getPermissionsRoleRights(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get the HTML Page for viewing the Rights (Permissions) for all of the Protocol Roles (Aggregator, Viewer, etc.).
protected void	preDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form) Any processing that must be performed before the save operation goes here.
protected org.apache.struts.action.ActionForward	saveOnClose(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Subclass can override this method in order to perform any operations when the document is saved on a close action.
org.apache.struts.action.ActionForward	setEditRoles(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Set the roles for a user for a given protocol.

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, getKualiRuleService, getNotificationService, getSubmitActionType, getUnitAclLoadService, getUnitRulesMessages, initialDocumentSave, isInitialSave, noteAndAttachment, onlineReview, permissions, personnel, postSave, preSave, printQuestionnaireAnswer, processMultipleLookupResults, protocol, protocolActions, questionnaire, recall, refresh, save, 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, 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

ProtocolPermissionsAction

public ProtocolPermissionsAction()

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

See Also:

KraTransactionalDocumentActionBase.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

preDocumentSave

protected void preDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
                        throws Exception

Description copied from class: KraTransactionalDocumentActionBase

Any processing that must be performed before the save operation goes here. Typically overridden by a subclass.

Overrides:

preDocumentSave in class KraTransactionalDocumentActionBase

Parameters:

form - the Form

Throws:

Exception

See Also:

org.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase#preDocumentSave(org.kuali.core.web.struts.form.KualiDocumentFormBase)

saveOnClose

protected org.apache.struts.action.ActionForward saveOnClose(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: KraTransactionalDocumentActionBase

Subclass can override this method in order to perform any operations when the document is saved on a close action.

Overrides:

saveOnClose in class ProtocolActionBase

Returns:

Throws:

Exception

See Also:

ProtocolActionBase.saveOnClose(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getPermissionsRoleRights

public org.apache.struts.action.ActionForward getPermissionsRoleRights(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 interface: PermissionsAction

Get the HTML Page for viewing the Rights (Permissions) for all of the Protocol Roles (Aggregator, Viewer, etc.).

Specified by:

getPermissionsRoleRights in interface PermissionsAction

Throws:

Exception

See Also:

PermissionsAction.getPermissionsRoleRights(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

addUser

public org.apache.struts.action.ActionForward addUser(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 interface: PermissionsAction

Add a new Protocol User to the list of users who can access a protocol. The user may be assigned any of the roles or the special unassigned role.

Specified by:

addUser in interface PermissionsAction

Throws:

Exception

See Also:

PermissionsAction.addUser(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

deleteUser

public org.apache.struts.action.ActionForward deleteUser(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 interface: PermissionsAction

Delete a Protocol User from the list of users who can access a protocol.

Specified by:

deleteUser in interface PermissionsAction

Throws:

Exception

See Also:

PermissionsAction.deleteUser(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

confirmDeletePermissionsUser

public org.apache.struts.action.ActionForward confirmDeletePermissionsUser(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 interface: PermissionsAction

If the the end-user confirms that a user must be deleted from the list of protocol users, then do so.

Specified by:

confirmDeletePermissionsUser in interface PermissionsAction

Throws:

Exception

See Also:

PermissionsAction.confirmDeletePermissionsUser(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

editRoles

public org.apache.struts.action.ActionForward editRoles(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 interface: PermissionsAction

Display the Edit Roles HTML web page. When the "edit role" button is pressed, the Edit Roles web page is displayed. The roles that the user is assigned to can then be modified.

Specified by:

editRoles in interface PermissionsAction

Throws:

Exception

See Also:

PermissionsAction.editRoles(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

setEditRoles

public org.apache.struts.action.ActionForward setEditRoles(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 interface: PermissionsAction

Set the roles for a user for a given protocol. The setEditRoles() method works in conjunction with the above editRoles() method. The editRoles() method causes the Edit Roles web page to be displayed. The setEditRoles() is invoked when the user clicks on the save button.

Specified by:

setEditRoles in interface PermissionsAction

Throws:

Exception

See Also:

PermissionsAction.setEditRoles(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)