com.canto.cumulus.db.permissions

Class Users

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.db.permissions.Users

public final class Users
extends RecordPackWrapper

This class manages a list of users.

See Also:

PermissionManager.getUsers(String)

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_USERS_LIST
static int	KEY_USERS_MORE_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
Users(JPack coreData)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areMoreUsersAvailable() Returns whether the list-generating call of PermissionManager.getUsers(String) has found more entries than this list contains.
int	countUsers() Returns the number of users contained in this list.
User	getUser(int index) Returns the user for the given index.
User	getUser(java.lang.String id) Returns the user for the given ID.
java.util.List<User>	getUsers() Returns a list of all user instances.

Methods inherited from class com.canto.cumulus.utils.RecordPackWrapper

toXMLString

Methods inherited from class java.lang.Object

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

Field Detail

KEY_USERS_LIST

public static final int KEY_USERS_LIST

KEY_USERS_MORE_AVAILABLE

public static final int KEY_USERS_MORE_AVAILABLE

Constructor Detail

Users

public Users(JPack coreData)

Method Detail

getUsers

public java.util.List<User> getUsers()

Returns a list of all user instances.

Returns:

list of all user instances

Since:

9.0

countUsers

public int countUsers()

Returns the number of users contained in this list.

Returns:

number of users

getUser

public User getUser(int index)

Returns the user for the given index.

Parameters:

index - index of the user to get

Returns:

found user

areMoreUsersAvailable

public boolean areMoreUsersAvailable()

Returns whether the list-generating call of PermissionManager.getUsers(String) has found more entries than this list contains.

Returns:

true if the list-generating call of PermissionManager.getUsers(String) has found more entries than this list contains

getUser

public User getUser(java.lang.String id)

Returns the user for the given ID.

Parameters:

id - user ID

Returns:

found user or null