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

Class RoleState

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class RoleState
extends Object
implements Serializable

Each RoleState corresponds to one specific user and one specific role. It stores the current state of the database, i.e. if "saved" is true, then the user is assigned to this role in the database. It also stores what the end-user wants the role assignment to be in the "assigned" property. If "assigned" is set to true, the end-user wants this user-role assignment to exists in the database; otherwise it should not be in the database. When the Permissions web page is viewed for the first time, the "saved" and "assigned" flags will have the same value. The end-user can then edit the roles for the users which will result in the "assigned" flags changing in value. When the document is saved, the "saved" and "assigned" flags are checked to see what roles need to be added and/or removed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RoleState(Role role)

Method Summary

Methods

Modifier and Type	Method and Description
Role	getRole()
boolean	isAssigned()
boolean	isSaved()
boolean	needsToBeAdded() Does this role have to be added to the database?
boolean	needsToBeRemoved() Does this role have to be removed from the database?
void	setAssigned(boolean assigned)
void	setSaved(boolean saved) When save state is set, the assigned state must be given the same value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleState

public RoleState(Role role)

Method Detail

getRole

public Role getRole()

isSaved

public boolean isSaved()

setSaved

public void setSaved(boolean saved)

When save state is set, the assigned state must be given the same value. The saveState() is invoked under two scenarios. The first is when the user-role assignments are read from the database and the roleState is created. The second is when the database is updated with new user-role assignments. In both cases, the saved and assigned must be the same to reflect what is in the database. The end-user is then free to change the assigned value to indicate what should be changed for the next database save.

Parameters:

saved -

isAssigned

public boolean isAssigned()

setAssigned

public void setAssigned(boolean assigned)

needsToBeAdded

public boolean needsToBeAdded()

Does this role have to be added to the database?

Returns:

true if needs to be added; otherwise false

needsToBeRemoved

public boolean needsToBeRemoved()

Does this role have to be removed from the database?

Returns:

true if needs to be removed; otherwise false