org.kuali.kra.common.permissions.web.struts.action

Interface PermissionsAction

All Known Implementing Classes:

IacucProtocolPermissionsAction, ProtocolPermissionsAction

public interface PermissionsAction

All Struts Action classes that support the Permissions tab web page must implement this interface. The Permissions Action class must respond to the following action requests from the web page.

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

Method Detail

getPermissionsRoleRights

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

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

Throws:

Exception

addUser

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

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.

Throws:

Exception

deleteUser

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

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

Throws:

Exception

confirmDeletePermissionsUser

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

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

Throws:

Exception

editRoles

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

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.

Throws:

Exception

setEditRoles

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

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.

Throws:

Exception