org.kuali.kra.irb.permission

Class PermissionsHelper

java.lang.Object

org.kuali.kra.common.permissions.web.struts.form.PermissionsHelperBase

org.kuali.kra.protocol.permission.PermissionsHelperBase

org.kuali.kra.irb.permission.PermissionsHelper

All Implemented Interfaces:

Serializable

public class PermissionsHelper
extends PermissionsHelperBase

The PermissionsHelper is used to manage the Permissions tab web page. It contains the data, forms, and methods needed to render the page.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.kra.protocol.permission.PermissionsHelperBase

AGGREGATOR_NAME, displayNameMap, excludeRoles, form, UNASSIGNED_NAME, VIEWER_NAME

Constructor Summary

Constructors

Constructor and Description
PermissionsHelper(ProtocolForm form)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildDisplayNameMap()
boolean	canModifyPermissions() Can the current user modify the users and their roles?
protected void	initExcludedRolesHook() This method initializes excluded role names within the namespace that should not be assignable in the permissions page.
protected boolean	isStandardRoleName(String roleName) Is this one of the standard roles? Every document comes with one or more standard roles (Aggregator, Budget Creator, Viewer, etc.).

Methods inherited from class org.kuali.kra.protocol.permission.PermissionsHelperBase

addNonDerivedRoles, buildRoles, getPersonsInRole, getProtocol, getRoleDisplayName, getRoleSelection, getRoleType, getSystemAuthorizationService, getUnassignedRoleName

Methods inherited from class org.kuali.kra.common.permissions.web.struts.form.PermissionsHelperBase

addNewUser, getAssignedRoles, getEditRoles, getKcPersonService, getKimPermissionService, getKimRoles, getModifyPermissions, getNewUser, getNormalRoles, getRole, getRoles, getSortedKimRoles, getTaskAuthorizationService, getUnassignedRoleDisplayName, getUserIdentifier, getUsers, getUserState, getUserStates, prepareView, resetUserStates, setRoles, setUserEditRoles

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsHelper

public PermissionsHelper(ProtocolForm form)

Method Detail

initExcludedRolesHook

protected void initExcludedRolesHook()

Description copied from class: PermissionsHelperBase

This method initializes excluded role names within the namespace that should not be assignable in the permissions page.

Specified by:

initExcludedRolesHook in class PermissionsHelperBase

buildDisplayNameMap

protected void buildDisplayNameMap()

Specified by:

buildDisplayNameMap in class PermissionsHelperBase

canModifyPermissions

public boolean canModifyPermissions()

Description copied from class: PermissionsHelperBase

Can the current user modify the users and their roles?

Specified by:

canModifyPermissions in class PermissionsHelperBase

Returns:

true if can modify the users and roles; otherwise false

isStandardRoleName

protected boolean isStandardRoleName(String roleName)

Description copied from class: PermissionsHelperBase

Is this one of the standard roles? Every document comes with one or more standard roles (Aggregator, Budget Creator, Viewer, etc.). End-users may also define extra roles to be used with the document. When displaying the roles, we want to display the standard roles before the user-defined roles. In order to do this, the derived class must define this method.

Specified by:

isStandardRoleName in class PermissionsHelperBase

Parameters:

roleName - the name of the role

Returns:

true if a standard role; otherwise false