org.pentaho.platform.api.usersettings

Interface IAnyUserSettingService

All Superinterfaces:

IPentahoInitializer, IUserSettingService

Deprecated.

@Deprecated
public interface IAnyUserSettingService
extends IUserSettingService

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteUserSettings(String username) Deprecated. Deletes all user settings for a specified username
IUserSetting	getUserSetting(String username, String settingName, String defaultValue) Deprecated. Gets a particular user setting for a specified username
List<IUserSetting>	getUserSettings(String username) Deprecated. Gets a list of all user settings for a specified username
void	setUserSetting(String username, String settingName, String settingValue) Deprecated. Sets a user setting for a specified username

Methods inherited from interface org.pentaho.platform.api.usersettings.IUserSettingService

deleteUserSettings, getGlobalUserSetting, getGlobalUserSettings, getUserSetting, getUserSettings, setGlobalUserSetting, setUserSetting

Methods inherited from interface org.pentaho.platform.api.engine.IPentahoInitializer

init

Method Detail

deleteUserSettings

void deleteUserSettings(String username)
                        throws SecurityException

Deprecated.

Deletes all user settings for a specified username

Parameters:

username - username to remove the setting from

Throws:

SecurityException - if the active user does not have the appropriate credentials to perform this operation

getUserSettings

List<IUserSetting> getUserSettings(String username)
                                   throws SecurityException

Deprecated.

Gets a list of all user settings for a specified username

Parameters:

username - username to get the setting for

Returns:

Throws:

SecurityException - if the active user does not have the appropriate credentials to perform this operation

getUserSetting

IUserSetting getUserSetting(String username,
                          String settingName,
                          String defaultValue)
                            throws SecurityException

Deprecated.

Gets a particular user setting for a specified username

Parameters:

username - username to get the setting for

settingName - name of the interested setting

defaultValue - default value if none found

Returns:

Throws:

SecurityException - if the active user does not have the appropriate credentials to perform this operation

setUserSetting

void setUserSetting(String username,
                  String settingName,
                  String settingValue)
                    throws SecurityException

Deprecated.

Sets a user setting for a specified username

Parameters:

username - username to get the setting for

settingName - name of the setting

settingValue - value of the setting

Throws:

SecurityException - if the active user does not have the appropriate credentials to perform this operation