org.kuali.kra.common.permissions.web.bean

Class UserState

java.lang.Object

org.kuali.kra.common.permissions.web.bean.UserState

All Implemented Interfaces:

Serializable

public class UserState
extends Object
implements Serializable

A UserState maintains the current roles for a person as well as the new roles. First, it must be understood how the Permissions tab web page works. The end-user can add/delete users to/from documents as well as change the roles that a user has. Those changes, though, do not take effect until a save is executed. Therefore, we must maintain the current state as saved in the database AND the new state as defined by the changes made by the end-user. When a save is executed, the current and new states are compared to determine the changes that are required to the database. To accomplish the above, each UserState maintains a person and all of the possible roles for that person. Each possible role is kept in the RoleState which stores the current ("saved") and new states ("assigned") for that role. By storing all of the possible roles that can be assigned to the user, the process of updating the database becomes a simple task. For example, if the new state is set to true and the current state is false, we know that the user must be assigned to that role. Likewise, if the reverse is true, we know that the the user must be removed from that role.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserState(KcPerson person, List<Role> roles) Constructs a UserState.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAssignments() Clear the assignments.
KcPerson	getPerson()
List<RoleState>	getRoleStates()
boolean	hasAnyRole() Is the user assigned to any role?
boolean	isRoleAssigned(String roleName) Is the user assigned to the given role?
void	setAssigned(String roleName, boolean assigned) Set the assigned value of a given role.
void	setSaved(String roleName, boolean saved) Set the saved state for a role.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserState

public UserState(KcPerson person,
         List<Role> roles)

Constructs a UserState.

Parameters:

person - the person

roles - all of the possible roles for a person

Method Detail

getPerson

public KcPerson getPerson()

getRoleStates

public List<RoleState> getRoleStates()

setSaved

public void setSaved(String roleName,
            boolean saved)

Set the saved state for a role.

Parameters:

roleName - the name of the role

saved - the new saved state

setAssigned

public void setAssigned(String roleName,
               boolean assigned)

Set the assigned value of a given role.

Parameters:

roleName - the name of the role

assigned - the new assigned value

isRoleAssigned

public boolean isRoleAssigned(String roleName)

Is the user assigned to the given role?

Parameters:

roleName - the name of the role

Returns:

true if the user is assigned to the role; otherwise false

clearAssignments

public void clearAssignments()

Clear the assignments.

hasAnyRole

public boolean hasAnyRole()

Is the user assigned to any role?

Returns:

true if if the user is assigned to any role; otherwise false