Package org.cyclos.impl.users

Enum GroupList

java.lang.Object

java.lang.Enum<GroupList>

org.cyclos.impl.users.GroupList

All Implemented Interfaces:

Serializable, Comparable<GroupList>

public enum GroupList
extends Enum<GroupList>

List of groups used to get a GroupListViewFactoryImpl from the GroupsHandler interface

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCESSIBLE	The list with the accessible groups configured in the product For guests it returns GuestSessionData.getAccessibleBasicGroups() (check its implementation for the included groups) Administrators only have this group list, i.e for such users, all other lists resolve to the this one.
ADS	The list with the groups a user can search advertisements of other users on.
DIRECTORY	The list with the groups a user can view other users on the directory map.
MENU	The list with the groups a user can search other users when searching from the search users menu.
USERS	The list with the groups a user can search other users on.

Method Summary

Modifier and Type	Method	Description
static GroupList	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GroupList[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACCESSIBLE

public static final GroupList ACCESSIBLE

The list with the accessible groups configured in the product For guests it returns GuestSessionData.getAccessibleBasicGroups() (check its implementation for the included groups) Administrators only have this group list, i.e for such users, all other lists resolve to the this one.

ADS

public static final GroupList ADS

The list with the groups a user can search advertisements of other users on. For logged users it resolves to the ACCESSIBLE list. Otherwise (guests) to the ConfigurationAccessor.getVisibleAdGroups() list.

USERS

public static final GroupList USERS

The list with the groups a user can search other users on. Only used to search for other members.
For guests it resolves to the ConfigurationAccessor.getGroupsForUserSearch() list.

DIRECTORY

public static final GroupList DIRECTORY

The list with the groups a user can view other users on the directory map. Only used to search for other members.
For guests it resolves to the ConfigurationAccessor.getGroupsForUserDirectory() list.

MENU

public static final GroupList MENU

The list with the groups a user can search other users when searching from the search users menu. Only used to search for other members.
This setting is in the configuration not in the product as for the other cases.

Method Detail

values

public static GroupList[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GroupList c : GroupList.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GroupList valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null