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.
|
Modifier and Type | Method and Description |
---|---|
Map<Scope,Map<String,SettingValue<String>>> |
SettingService.getSettingsByContext(Context context)
Get settings related to a scope and a context
|
Modifier and Type | Method and 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.
|
Modifier and Type | Field and Description |
---|---|
static Scope |
Scope.APPLICATION
Settings of an application, like Forum, Content, or Social.
|
static Scope |
Scope.GLOBAL
Settings of the whole eXo Platform (all sites and portals).
|
static Scope |
Scope.PAGE
Settings of pages.
|
static Scope |
Scope.PORTAL
Settings of the entire portal (and all its sites).
|
protected Scope |
SettingScope.scope |
static Scope |
Scope.SITE
Settings of sites.
|
static Scope |
Scope.SPACE
Settings of spaces.
|
static Scope |
Scope.WINDOWS
Settings of portlets or gadgets.
|
Modifier and Type | Method and Description |
---|---|
Scope |
SettingScope.getScope()
Gets a scope value of the SettingScope object.
|
Scope |
Scope.id(String id) |
Modifier and Type | Method and Description |
---|---|
static String |
Tools.buildFullPath(Context context,
Scope scope,
String key)
Builds a path of a specified setting property stored in the database.
|
static String |
Tools.buildScopePath(Context context,
Scope scope)
Builds a path of a specified scope in the database.
|
Constructor and 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].
|
Copyright © 2003–2019 eXo Platform SAS. All rights reserved.