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

Class PermissionsHelperBase

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PermissionsHelper, PermissionsHelperBase, ProtocolPrintPermissionUtils, ProtocolPrintPermissionUtils

public abstract class PermissionsHelperBase
extends Object
implements Serializable

The PermissionsHelperBase is the base class of all PermissionsHelperBase classes. Every document that requires a Permissions tab web page must have a form that has a PermissionsHelperBase derived from PermissionsHelperBase.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PermissionsHelperBase() Constructs a AbstractPermissionsHelper with a null role type.
PermissionsHelperBase(String roleType) Constructs an AbstractPermissionsHelper.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewUser() Add the new user to the list of UserStates.
protected void	buildRoles(String roleType)
abstract boolean	canModifyPermissions() Can the current user modify the users and their roles?
List<AssignedRole>	getAssignedRoles() Get the list of assigned roles.
PermissionsUserEditRoles	getEditRoles() Get the form data for editing the roles for a user.
protected KcPersonService	getKcPersonService() Gets the KC Person Service.
protected org.kuali.rice.kim.api.permission.PermissionService	getKimPermissionService()
protected List<org.kuali.rice.kim.api.role.Role>	getKimRoles(String roleType) Get the list of Kim Roles.
boolean	getModifyPermissions() Get the ModifyPermissions value.
PermissionsUser	getNewUser() Gets the new user.
List<Role>	getNormalRoles() Get the "normal" roles for the document.
protected abstract List<KcPerson>	getPersonsInRole(String roleName) Get the persons in a role.
Role	getRole(String roleName) Get a specific role.
protected String	getRoleDisplayName(String roleName) Get the role's display name.
List<Role>	getRoles() Get the roles for the document.
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.
protected List<org.kuali.rice.kim.api.role.Role>	getSortedKimRoles(String roleType) Get the sorted list of KIM roles.
protected TaskAuthorizationService	getTaskAuthorizationService()
String	getUnassignedRoleDisplayName() Get the display name of the unassigned role.
String	getUnassignedRoleName() Get the name of the unassigned role.
protected String	getUserIdentifier() Get the userName of the user for the current session.
List<User>	getUsers() Get the users.
UserState	getUserState(String userName) Get a UserState for a particular user.
List<UserState>	getUserStates() Get all of the users and their current role states.
protected abstract 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.).
void	prepareView() To prepare a view, the set of users and their roles must be initialized only once.
void	resetUserStates() This method empties the userStates cache such that the data is updated.
protected void	setRoles(List<Role> roles) Set the roles, this is for classes that have to override the buildRoles or otherwise need to set the List.
void	setUserEditRoles(PermissionsUserEditRoles editRoles) Get the UserEditRoles which is the form data for the Edit Roles web page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsHelperBase

public PermissionsHelperBase()

Constructs a AbstractPermissionsHelper with a null role type.

PermissionsHelperBase

public PermissionsHelperBase(String roleType)

Constructs an AbstractPermissionsHelper.

Parameters:

roleType - the type of role (may be null)

Method Detail

prepareView

public void prepareView()

To prepare a view, the set of users and their roles must be initialized only once. Keep in mind that the Initiator must be added as an Administrator (Aggregator) once the document is initially saved. Therefore, we keep building the set of users until it has at least one user.

resetUserStates

public void resetUserStates()

This method empties the userStates cache such that the data is updated. Needed when adding or removing permissions through service calls.

canModifyPermissions

public abstract boolean canModifyPermissions()

Can the current user modify the users and their roles?

Returns:

true if can modify the users and roles; otherwise false

getModifyPermissions

public boolean getModifyPermissions()

Get the ModifyPermissions value.

Returns:

the ModifyPermissions value

getRoles

public List<Role> getRoles()

Get the roles for the document.

Returns:

the roles for the document

setRoles

protected void setRoles(List<Role> roles)

Set the roles, this is for classes that have to override the buildRoles or otherwise need to set the List.

getEditRoles

public PermissionsUserEditRoles getEditRoles()

Get the form data for editing the roles for a user.

Returns:

the EditRoles form data

getNormalRoles

public List<Role> getNormalRoles()

Get the "normal" roles for the document. The excludes the special "unassigned" role if it is available. Sometimes, such as the Edit Roles web page, we don't want to show the unassigned role.

Returns:

the "normal" roles for the document

getUserStates

public List<UserState> getUserStates()

Get all of the users and their current role states.

Returns:

the users and their role states

getUserState

public UserState getUserState(String userName)

Get a UserState for a particular user.

Parameters:

userName - the user's unique userName

Returns:

the user's UserState or null if not found

getUnassignedRoleName

public String getUnassignedRoleName()

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.

Returns:

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

getUnassignedRoleDisplayName

public String getUnassignedRoleDisplayName()

Get the display name of the unassigned role.

Returns:

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

isStandardRoleName

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

Parameters:

roleName - the name of the role

Returns:

true if a standard role; otherwise false

getRoleDisplayName

protected String getRoleDisplayName(String roleName)

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

Parameters:

roleName - the name of the role

Returns:

the role's display name

getPersonsInRole

protected abstract List<KcPerson> getPersonsInRole(String roleName)

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

Parameters:

roleName - the name of the role

Returns:

the list of persons

buildRoles

protected void buildRoles(String roleType)

getSortedKimRoles

protected List<org.kuali.rice.kim.api.role.Role> getSortedKimRoles(String roleType)

Get the sorted list of KIM roles. By sorted, we mean that any unassigned role is shown first, followed by the standard roles, and then by the user-defined roles.

Returns:

the sorted list of KIM roles

getKimRoles

protected List<org.kuali.rice.kim.api.role.Role> getKimRoles(String roleType)

Get the list of Kim Roles. The default implementation gets all of the roles for a particular type. If roleType was set to null in the constructor, the derived class must override this method to obtain the roles for the document.

Returns:

the list of KIM roles for the document

getRole

public Role getRole(String roleName)

Get a specific role.

Parameters:

roleName - the name of the role

Returns:

the role or null if not found

getAssignedRoles

public List<AssignedRole> getAssignedRoles()

Get the list of assigned roles. This is used by the Assigned Roles panel on the Permissions tab web page. Each role has a sorted list of the userNames assigned to that role. Note that the unassigned role is excluded.

Returns:

the list of assigned roles

getUsers

public List<User> getUsers()

Get the users. This is the list of users as shown on the Users panel on the Permissions web page.

Returns:

the sorted list of users

getNewUser

public PermissionsUser getNewUser()

Gets the new user. This is the user that is filled in by the end-user on the Users panel in the Permissions web page.

Returns:

the new user

addNewUser

public void addNewUser()

Add the new user to the list of UserStates. Note that the person will never be null since the business rules will verify the person's existence in the database.

getRoleSelection

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

Returns:

list of roles for the drop-down menu

setUserEditRoles

public void setUserEditRoles(PermissionsUserEditRoles editRoles)

Get the UserEditRoles which is the form data for the Edit Roles web page.

Parameters:

editRoles - the form data for the Edit Roles web page

getTaskAuthorizationService

protected TaskAuthorizationService getTaskAuthorizationService()

getKcPersonService

protected KcPersonService getKcPersonService()

Gets the KC Person Service.

Returns:

KC Person Service.

getKimPermissionService

protected org.kuali.rice.kim.api.permission.PermissionService getKimPermissionService()

getUserIdentifier

protected String getUserIdentifier()

Get the userName of the user for the current session.

Returns:

the current session's userName