org.kuali.kra.protocol.permission

Class PermissionsHelperBase

java.lang.Object

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

org.kuali.kra.protocol.permission.PermissionsHelperBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IacucPermissionsHelper, PermissionsHelper

public abstract class PermissionsHelperBase
extends PermissionsHelperBase

The PermissionsHelperBase 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

Modifier and Type	Field and Description
protected static String	AGGREGATOR_NAME
protected Map<String,String>	displayNameMap Stores mapping of role names to display names.
protected Collection<String>	excludeRoles
protected ProtocolFormBase	form Each Helper must contain a reference to its document form so that it can access the document.
protected static String	UNASSIGNED_NAME
protected static String	VIEWER_NAME

Constructor Summary

Constructors

Constructor and Description
PermissionsHelperBase(ProtocolFormBase form, String roleType) Constructs a PermissionsHelperBase.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNonDerivedRoles(List<org.kuali.rice.core.api.util.KeyValue> keyValues)
protected abstract void	buildDisplayNameMap()
protected void	buildRoles(String roleType)
protected List<KcPerson>	getPersonsInRole(String roleName) Get the persons in a role.
protected ProtocolBase	getProtocol()
protected String	getRoleDisplayName(String roleName) Get the role's display name.
List<org.kuali.rice.core.api.util.KeyValue>	getRoleSelection() Get list of roles to display in the drop-down menu in the Users panel of the Permissions web page.
String	getRoleType()
protected SystemAuthorizationService	getSystemAuthorizationService()
String	getUnassignedRoleName() Get the name of the unassigned role.
protected abstract void	initExcludedRolesHook() This method initializes excluded role names within the namespace that should not be assignable in the permissions page.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

AGGREGATOR_NAME

protected static final String AGGREGATOR_NAME

See Also:

Constant Field Values

VIEWER_NAME

protected static final String VIEWER_NAME

See Also:

Constant Field Values

UNASSIGNED_NAME

protected static final String UNASSIGNED_NAME

See Also:

Constant Field Values

excludeRoles

protected Collection<String> excludeRoles

form

protected ProtocolFormBase form

Each Helper must contain a reference to its document form so that it can access the document.

displayNameMap

protected Map<String,String> displayNameMap

Stores mapping of role names to display names.

Constructor Detail

PermissionsHelperBase

public PermissionsHelperBase(ProtocolFormBase form,
                     String roleType)

Constructs a PermissionsHelperBase.

Parameters:

form - the form

Method Detail

initExcludedRolesHook

protected abstract void initExcludedRolesHook()

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

buildDisplayNameMap

protected abstract void buildDisplayNameMap()

getRoleSelection

public List<org.kuali.rice.core.api.util.KeyValue> getRoleSelection()

Description copied from class: PermissionsHelperBase

Get list of roles to display in the drop-down menu in the Users panel of the Permissions web page.

Overrides:

getRoleSelection in class PermissionsHelperBase

Returns:

list of roles for the drop-down menu

addNonDerivedRoles

protected void addNonDerivedRoles(List<org.kuali.rice.core.api.util.KeyValue> keyValues)

getSystemAuthorizationService

protected SystemAuthorizationService getSystemAuthorizationService()

getProtocol

protected ProtocolBase getProtocol()

getUnassignedRoleName

public String getUnassignedRoleName()

Description copied from class: PermissionsHelperBase

Get the name of the unassigned role. If the derived class needs to support an unassigned role, it must override this method and to provide the role name.

Overrides:

getUnassignedRoleName in class PermissionsHelperBase

Returns:

the name of the unassigned role or null if the unassigned role is not supported

See Also:

PermissionsHelperBase.getUnassignedRoleName()

getRoleDisplayName

protected String getRoleDisplayName(String roleName)

Description copied from class: PermissionsHelperBase

Get the role's display name. By default, the name of role is also its display name. A derived class may override this method in order to change the display name. For example, one may wish to have the "ProtocolBase Aggregator" role simply displayed as "Aggregator".

Overrides:

getRoleDisplayName in class PermissionsHelperBase

Parameters:

roleName - the name of the role

Returns:

the role's display name

See Also:

PermissionsHelperBase.getRoleDisplayName(java.lang.String)

buildRoles

protected void buildRoles(String roleType)

Overrides:

buildRoles in class PermissionsHelperBase

getPersonsInRole

protected List<KcPerson> getPersonsInRole(String roleName)

Description copied from class: PermissionsHelperBase

Get the persons in a role. Must be overridden by the derived class.

Specified by:

getPersonsInRole in class PermissionsHelperBase

Parameters:

roleName - the name of the role

Returns:

the list of persons

See Also:

PermissionsHelperBase.getPersonsInRole(java.lang.String)

getRoleType

public String getRoleType()