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>

This class allow a user to be able to save some settings linked to a scope.

Enum Constant Summary

APPLICATION
Settings for an application like Forum, Content, Social, etc.

GLOBAL
Settings for the platform (for all sites and portals).

PAGE
Settings for a page.

PORTAL
Settings for the entire portal (and all these sites).

SITE
Settings for one site in one portal.

SPACE
Settings for a space.

WINDOWS
Settings for portlets or gadgets.

Method Summary

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 for portlets or gadgets.

PAGE

public static final Scope PAGE

Settings for a page.

SPACE

public static final Scope SPACE

Settings for a space.

SITE

public static final Scope SITE

Settings for one site in one portal.

PORTAL

public static final Scope PORTAL

Settings for the entire portal (and all these sites).

APPLICATION

public static final Scope APPLICATION

Settings for an application like Forum, Content, Social, etc.

GLOBAL

public static final Scope GLOBAL

Settings for the platform (for all sites and portals).

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()