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

Class PermissionsActionHelperBase

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ProtocolPermissionsActionHelper

public abstract class PermissionsActionHelperBase
extends Object
implements Serializable

The PermissionsActionHelperBase is a delegate for supporting the Permissions Tab web page. A subclass is necessary to perform operations specific to the document and roles for the Permissions web page, e.g. saving users and roles to the database.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PermissionsActionHelperBase(KraTransactionalDocumentActionBase parentAction)

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 user with a role to the document.
protected abstract void	addUserToRoleInDatabase(org.kuali.rice.krad.document.Document document, String userId, String roleName) Assign a user to the given role for a specific document.
protected boolean	applyRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
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, 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 user and his/her roles from the document.
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) Edit the roles for a user.
org.apache.struts.action.ActionForward	getRoleRights(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get the Role Rights web page.
protected abstract void	removeUserFromRoleInDatabase(org.kuali.rice.krad.document.Document document, String userId, String roleName) Remove a user from a role for a specific document.
void	save(PermissionsForm form) Save the changes to the database.
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 document.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsActionHelperBase

protected PermissionsActionHelperBase(KraTransactionalDocumentActionBase parentAction)

Method Detail

addUserToRoleInDatabase

protected abstract void addUserToRoleInDatabase(org.kuali.rice.krad.document.Document document,
                           String userId,
                           String roleName)

Assign a user to the given role for a specific document.

Parameters:

document - the document

userName - the user's unique userName

roleName - the unique name of the role

removeUserFromRoleInDatabase

protected abstract void removeUserFromRoleInDatabase(org.kuali.rice.krad.document.Document document,
                                String userId,
                                String roleName)

Remove a user from a role for a specific document.

Parameters:

document - the document

userName - the user's unique userName

roleName - the unique name of the role

save

public void save(PermissionsForm form)
          throws Exception

Save the changes to the database. All of the changes involve either adding or removing roles for a user.

Parameters:

form - the form

Throws:

Exception

getRoleRights

public org.apache.struts.action.ActionForward getRoleRights(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 Role Rights web page.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

addUser

public final 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 user with a role to the document.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteUser

public final 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 user and his/her roles from the document.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

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

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

Parameters:

mapping - the mapping associated with this action.

form - the form.

request - the HTTP request

response - the HTTP response

Returns:

the Permissions web page

Throws:

Exception

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

Edit the roles for a user.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

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

Set the roles for a user for a given document. 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. Note that the Edit Roles BO created in editRoles() is retrieved in setEditRoles() to determine the user and what the new roles should be.

Parameters:

mapping - the mapping associated with this action.

form - the form.

request - the HTTP request

response - the HTTP response

Returns:

the next web page to display

Throws:

Exception

applyRules

protected final boolean applyRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)