org.kuali.kra.award.permissions

Class PermissionsHelper

java.lang.Object

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

org.kuali.kra.award.permissions.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

Constructor Summary

Constructors

Constructor and Description
PermissionsHelper(AwardForm form) Constructs a PermissionsHelper.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canModifyPermissions() Can the current user modify the users and their roles?
boolean	getMaintainAwardReportTracking()
protected List<KcPerson>	getPersonsInRole(String roleName) Get the persons in a role.
protected String	getRoleDisplayName(String roleName) Get the role's display name.
String	getUnassignedRoleName() Get the name of the unassigned role.
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.common.permissions.web.struts.form.PermissionsHelperBase

addNewUser, buildRoles, getAssignedRoles, getEditRoles, getKcPersonService, getKimPermissionService, getKimRoles, getModifyPermissions, getNewUser, getNormalRoles, getRole, getRoles, getRoleSelection, 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(AwardForm form)

Constructs a PermissionsHelper.

Parameters:

form - the form

Method Detail

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

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

See Also:

PermissionsHelperBase.isStandardRoleName(java.lang.String)

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)

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)

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

See Also:

PermissionsHelperBase.canModifyPermissions()

getMaintainAwardReportTracking

public boolean getMaintainAwardReportTracking()