org.exoplatform.commons.api.settings.data

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.exoplatform.commons.api.settings.data.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

public enum Scope
extends Enum<Scope>

Saves some settings linked to a scope.

Level API:

Experimental

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION Settings of an application, like Forum, Content, or Social.
GLOBAL Settings of the whole eXo Platform (all sites and portals).
PAGE Settings of pages.
PORTAL Settings of the entire portal (and all its sites).
SITE Settings of sites.
SPACE Settings of spaces.
WINDOWS Settings of portlets or gadgets.

Method Summary

Methods

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

WINDOWS

public static final Scope WINDOWS

Settings of portlets or gadgets.

Level API:

Experimental

PAGE

public static final Scope PAGE

Settings of pages.

Level API:

Experimental

SPACE

public static final Scope SPACE

Settings of spaces.

Level API:

Experimental

SITE

public static final Scope SITE

Settings of sites.

Level API:

Experimental

PORTAL

public static final Scope PORTAL

Settings of the entire portal (and all its sites).

Level API:

Experimental

APPLICATION

public static final Scope APPLICATION

Settings of an application, like Forum, Content, or Social.

Level API:

Experimental

GLOBAL

public static final Scope GLOBAL

Settings of the whole eXo Platform (all sites and portals).

Level API:

Experimental

Method Detail

values

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

Returns:

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

valueOf

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

id

public Scope id(String id)

getId

public String getId()