org.cyclos.model.system.configurations

Enum UserSearchInMenuMode

java.lang.Object

java.lang.Enum<UserSearchInMenuMode>

org.cyclos.model.system.configurations.UserSearchInMenuMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UserSearchInMenuMode>, HasMessageKey

public enum UserSearchInMenuMode
extends java.lang.Enum<UserSearchInMenuMode>
implements HasMessageKey

The modes for search users from the menu

Author:

ameyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_IN_USER_SEARCH The available groups for search are those in the "Search users on groups" product setting for logged users (in case of administrators are the accessible ones) and as configuration setting for guests.
NONE There is no available groups for search from the menu (i.e the search users menu is hidden)
SPECIFIC_GROUPS The available groups for search users is a specific list.

Method Summary

Modifier and Type	Method and Description
MessageKey	getMessageKey()
boolean	isHideUserSearchInMenu() Returns true if the search users menu must be hidden
static UserSearchInMenuMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UserSearchInMenuMode[]	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

ALL_IN_USER_SEARCH

public static final UserSearchInMenuMode ALL_IN_USER_SEARCH

The available groups for search are those in the "Search users on groups" product setting for logged users (in case of administrators are the accessible ones) and as configuration setting for guests.

SPECIFIC_GROUPS

public static final UserSearchInMenuMode SPECIFIC_GROUPS

The available groups for search users is a specific list.

NONE

public static final UserSearchInMenuMode NONE

There is no available groups for search from the menu (i.e the search users menu is hidden)

Method Detail

values

public static UserSearchInMenuMode[] 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 (UserSearchInMenuMode c : UserSearchInMenuMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static UserSearchInMenuMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

isHideUserSearchInMenu

public boolean isHideUserSearchInMenu()

Returns true if the search users menu must be hidden