Package lumis.portal.preferences

Enum PreferencesLevel

java.lang.Object

java.lang.Enum<PreferencesLevel>

lumis.portal.preferences.PreferencesLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PreferencesLevel>

@StableMinor(version="17.0",
             sinceVersion="10.2")
public enum PreferencesLevel
extends java.lang.Enum<PreferencesLevel>

The preferences level where a preferences value may be stored.

Since:

10.2.0

Version:

$Revision$ $Date$

Enum Constant Summary

Enum Constants

Enum Constant	Description
SHARED	Preferences stored at shared level are shared among all users.
STRUCTURE	Preferences stored at structure level are affected by import/export structure operations.
USER	Preferences stored at user level are only visible to the corresponding user.

Method Summary

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

STRUCTURE

public static final PreferencesLevel STRUCTURE

Preferences stored at structure level are affected by import/export structure operations.

Since:

10.2.0

SHARED

public static final PreferencesLevel SHARED

Preferences stored at shared level are shared among all users. It inherits values not specified on it from the structure level preferences.

Since:

10.2.0

USER

public static final PreferencesLevel USER

Preferences stored at user level are only visible to the corresponding user. It inherits values not specified on it from the shared level preferences.

Since:

10.2.0

Method Detail

values

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

Returns:

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

valueOf

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