Package com.uc4.api.objects

Class UserPrivileges

java.lang.Object

com.uc4.api.objects.UserPrivileges

public class UserPrivileges
extends Object

This class represents the privileges of a user. It serves to allow or to deny the User access to system functions. Privileges are an integral part of the Authorization System.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserPrivileges.Privilege	Enumeration of all Privileges.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserPrivileges(com.uc4.util.XMLDocument doc)

Method Summary

Modifier and Type	Method	Description
boolean	isPrivilegeSet(UserPrivileges.Privilege priv)	Returns true if the specified privilege is enabled.
void	selectAll()	Enables all NOT deprecated privileges.
void	setPrivilege(UserPrivileges.Privilege priv, boolean value)	Sets or clears a privilege.
protected void	store(com.uc4.util.XMLDocument doc, Element objectElement)
void	unselectAll()	Disables all privileges.

Methods inherited from class java.lang.Object

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

Constructor Details

UserPrivileges

protected UserPrivileges(com.uc4.util.XMLDocument doc)

Method Details

store

protected void store(com.uc4.util.XMLDocument doc,
 Element objectElement)

isPrivilegeSet

public boolean isPrivilegeSet(UserPrivileges.Privilege priv)

Returns true if the specified privilege is enabled.

Parameters:

priv - Privilege

Returns:

true if enabled, false otherwise

setPrivilege

public void setPrivilege(UserPrivileges.Privilege priv,
 boolean value)

Sets or clears a privilege.

Parameters:

priv - Enum constant

value - true to enable the privilege, false to disable it

selectAll

public void selectAll()

Enables all NOT deprecated privileges.

unselectAll

public void unselectAll()

Disables all privileges.