Uses of Class
org.exoplatform.commons.api.settings.data.Scope

Packages that use Scope

Package	Description
org.exoplatform.commons.api.settings	Provides the API for the Setting service.
org.exoplatform.commons.api.settings.data	Provides enum types and classes for key specifications in the Setting service.

Uses of Scope in org.exoplatform.commons.api.settings

Methods in org.exoplatform.commons.api.settings that return types with arguments of type Scope

Modifier and Type	Method	Description
Map<Scope,Map<String,SettingValue<String>>>	SettingService.getSettingsByContext(Context context)	Get settings related to a scope and a context

Methods in org.exoplatform.commons.api.settings with parameters of type Scope

Modifier and Type	Method	Description
SettingValue<?>	SettingService.get(Context context, Scope scope, String key)	Gets values associated with a specified composite key (context, scope, key) in the database.
void	SettingService.remove(Context context, Scope scope)	Removes all values associated with a specified context and scope from the database.
void	SettingService.remove(Context context, Scope scope, String key)	Removes a value associated with a specified composite key.
void	SettingService.set(Context context, Scope scope, String key, SettingValue<?> value)	Sets a value with the key that is composed by context, scope, key.

Uses of Scope in org.exoplatform.commons.api.settings.data

Fields in org.exoplatform.commons.api.settings.data declared as Scope

Modifier and Type	Field	Description
static final Scope	Scope.APPLICATION	Settings of an application, like Forum, Content, or Social.
static final Scope	Scope.GLOBAL	Settings of the whole eXo Platform (all sites and portals).
static final Scope	Scope.PAGE	Settings of pages.
static final Scope	Scope.PORTAL	Settings of the entire portal (and all its sites).
protected Scope	SettingScope.scope
static final Scope	Scope.SITE	Settings of sites.
static final Scope	Scope.SPACE	Settings of spaces.
static final Scope	Scope.WINDOWS	Settings of portlets or gadgets.

Methods in org.exoplatform.commons.api.settings.data that return Scope

Modifier and Type	Method	Description
Scope	Scope.clone()
Scope	SettingScope.getScope()	Gets a scope value of the SettingScope object.
Scope	Scope.id(String id)

Methods in org.exoplatform.commons.api.settings.data with parameters of type Scope

Modifier and Type	Method	Description
static String	Tools.buildScopePath(Context context, Scope scope)	Builds a path of a specified scope in the database.

Constructors in org.exoplatform.commons.api.settings.data with parameters of type Scope

Modifier	Constructor	Description
	SettingKey(Context context, Scope scope, String key)	Creates a SettingKey with a composite value [context, scope, key].
	SettingScope(Context context, Scope scope)	Creates a setting scope object with a composite key [context, scope].