org.cyclos.model.system.configurations

Enum AllowAccessMode

java.lang.Object

java.lang.Enum<AllowAccessMode>

org.cyclos.model.system.configurations.AllowAccessMode

All Implemented Interfaces:

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

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

Used to determine how users are allowed to access this configuration

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY The user can access from any URL
CURRENT_ONLY The user can access only from the current configuration URL
CURRENT_OR_ANCESTORS The user can access from the current configuration URL or any ancestor (default)

Method Summary

Modifier and Type	Method and Description
MessageKey	getMessageKey()
static AllowAccessMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AllowAccessMode[]	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

CURRENT_OR_ANCESTORS

public static final AllowAccessMode CURRENT_OR_ANCESTORS

The user can access from the current configuration URL or any ancestor (default)

CURRENT_ONLY

public static final AllowAccessMode CURRENT_ONLY

The user can access only from the current configuration URL

ANY

public static final AllowAccessMode ANY

The user can access from any URL

Method Detail

values

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

Returns:

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

valueOf

public static AllowAccessMode 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