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

Packages that use Context

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 Context in org.exoplatform.commons.api.settings

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

Modifier and Type	Method and Description
List<Context>	SettingService.getContextsByTypeAndScopeAndSettingName(String contextType, String scopeType, String scopeName, String settingName, int offset, int limit) Gets a list of names of contexts of a chosen type that have a setting associated to a dedicated scope

Methods in org.exoplatform.commons.api.settings with parameters of type 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.
Map<Scope,Map<String,SettingValue<String>>>	SettingService.getSettingsByContext(Context context) Get settings related to a scope and a context
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.save(Context context) Saves a Context on database
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 Context in org.exoplatform.commons.api.settings.data

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

Modifier and Type	Field and Description
protected Context	SettingContext.context Context of the setting object.
static Context	Context.GLOBAL GLOBAL: Settings should impact all users in the underlying scope.
static Context	Context.USER USER: Each user should be able to save his own settings.

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

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.

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

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.

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

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].