| 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 | 
|---|---|
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)
Removes all values associated with a specified context from 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 | 
|---|---|
protected Context | 
SettingContext.context
Context of the setting object. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Context | 
SettingContext.getContext()
Gets a context object associated with the SettingContext object. 
 | 
Context | 
Context.id(String id)
Creates a context with a specified Id. 
 | 
static Context | 
Context.valueOf(String name)
Returns the enum constant of this type with the specified name. 
 | 
static Context[] | 
Context.values()
Returns an array containing the constants of this enum type, in
the order they are declared. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static String | 
Tools.buildContextPath(Context context)
Builds a path of a specified context in the database. 
 | 
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 | 
|---|
SettingContext(Context context)
Creates a SettingContext object with a specified context type. 
 | 
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-2017 eXo Platform SAS. All Rights Reserved.