com.canto.cumulus.usermanagement

Class User

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.usermanagement.User

Direct Known Subclasses:

ExternalUser

public class User
extends BaseManager

Instances of this class represent a single user. You can create a user by calling AuthenticationManager.getUser(String), AuthenticationManager.createUser(String) or AuthenticationManager.duplicateUser(String, String).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.RoleNames Manages the roles a user is assigned to.

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
void	addRole(Role role) Adds this user to the specified role.
int	getDepartmentID() Returns the ID of the department of this user.
FieldValues	getFieldValues() Returns the container representing all field values of this user.
java.lang.String	getName() Returns the User name.
User.RoleNames	getRoleNames() Returns the names of roles this user is assigned to.
boolean	isActive() Return whether this user is able to log in.
void	removeRole(java.lang.String roleName) Removes a role from the roles assigned to this user.
void	save() Saves the changes for this user.
void	setDepartmentID(int id) Configures the ID of the department of this user.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Returns the User name.

Returns:

the User name.

getDepartmentID

public int getDepartmentID()

Returns the ID of the department of this user.

Returns:

ID of the department of this user

Since:

8.5

setDepartmentID

public void setDepartmentID(int id)

Configures the ID of the department of this user.

Parameters:

id - ID of the department of this user

Since:

8.5

isActive

public boolean isActive()

Return whether this user is able to log in.

Returns:

true if this user can log in.

getFieldValues

public FieldValues getFieldValues()

Returns the container representing all field values of this user.

Returns:

instance that allows accessing the field values of this user

getRoleNames

public User.RoleNames getRoleNames()

Returns the names of roles this user is assigned to.

Returns:

the instance that manages the roles this user is a part of

addRole

public void addRole(Role role)

Adds this user to the specified role.

Parameters:

role - the role to add this user to.

removeRole

public void removeRole(java.lang.String roleName)

Removes a role from the roles assigned to this user.

Parameters:

roleName - the role name

save

public void save()

Saves the changes for this user.

Overrides:

save in class BaseManager