org.apache.marmotta.platform.user.api

Interface UserConfigurationService

All Known Implementing Classes:

UserConfigurationServiceImpl

public interface UserConfigurationService

Add file description here!

Author: Sebastian Schaffert

Method Summary

Methods

Modifier and Type	Method and Description
String	getUserConfiguration(UserAccount user, String key) Get the configuration for the given user and key.
String	getUserConfiguration(UserAccount user, String key, String defaultValue) Get the configuration for the given user and key.
List<Object>	getUserListConfiguration(UserAccount user, String key) Return the list configuration value of the given key for the given user.
List<Object>	getUserListConfiguration(UserAccount user, String key, List<Object> defaultValue) Return the list configuration value of the given key for the given user.
boolean	isUserConfigurationSet(UserAccount user, String key) Check whether the given configuration is set for the given user.
void	removeUserConfiguration(UserAccount user, String key) Remove the user configuration identified by "key" from the database.
void	setUserConfiguration(UserAccount user, String key, String value) Set the configuration "key" to the string value "value".
void	setUserListConfiguration(UserAccount user, String key, List<String> values) Set the configuration "key" to the string value "value".

Method Detail

isUserConfigurationSet

boolean isUserConfigurationSet(UserAccount user,
                             String key)

Check whether the given configuration is set for the given user.

Parameters:

user -

key -

Returns:

getUserConfiguration

String getUserConfiguration(UserAccount user,
                          String key)

Get the configuration for the given user and key. If there is no such configuration, a new one is created with empty value (returns null).

Parameters:

user - the user for whom to get the configuration

key - unique configuration key for lookup

Returns:

a configuration object with either the configured value or null as value

getUserConfiguration

String getUserConfiguration(UserAccount user,
                          String key,
                          String defaultValue)

Get the configuration for the given user and key. If there is no such configuration, a new one is created using the provided defaultValue as string value.

Parameters:

user - the user for whom to get the configuration

key - unique configuration key for lookup

defaultValue - default value if configuration not found

Returns:

a configuration object with either the configured value or defaultValue

setUserConfiguration

void setUserConfiguration(UserAccount user,
                        String key,
                        String value)

Set the configuration "key" to the string value "value".

Parameters:

key -

value -

setUserListConfiguration

void setUserListConfiguration(UserAccount user,
                            String key,
                            List<String> values)

Set the configuration "key" to the string value "value".

Parameters:

key -

values -

getUserListConfiguration

List<Object> getUserListConfiguration(UserAccount user,
                                    String key)

Return the list configuration value of the given key for the given user. If there is no value for the key, returns the empty list.

Parameters:

user -

getUserListConfiguration

List<Object> getUserListConfiguration(UserAccount user,
                                    String key,
                                    List<Object> defaultValue)

Return the list configuration value of the given key for the given user. Returns the given defaultValue if no configuration is found for the given key.

Parameters:

user -

removeUserConfiguration

void removeUserConfiguration(UserAccount user,
                           String key)

Remove the user configuration identified by "key" from the database.

Parameters:

key -