org.pentaho.platform.web.http.api.resources

Class UserSettingsResource

java.lang.Object

org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

org.pentaho.platform.web.http.api.resources.UserSettingsResource

public class UserSettingsResource
extends AbstractJaxRSResource

This resource manages the user settings of the platform

Field Summary

Fields inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

TEXT_HTML

Constructor Summary

Constructors

Constructor and Description
UserSettingsResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getUserSetting(String setting) Retrieve a particular user setting for the current user
ArrayList<Setting>	getUserSettings() Retrieve the global settings and the user settings for the current user
javax.ws.rs.core.Response	setUserSetting(String setting, String settingValue) Save the value of a particular setting for the current user

Methods inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

setHttpHeaders

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserSettingsResource

public UserSettingsResource()

Method Detail

getUserSettings

public ArrayList<Setting> getUserSettings()

Retrieve the global settings and the user settings for the current user

Returns:

list of settings for the platform

getUserSetting

public javax.ws.rs.core.Response getUserSetting(String setting)

Retrieve a particular user setting for the current user

Parameters:

setting - (Name of the setting)

Returns:

value of the setting for the user

setUserSetting

public javax.ws.rs.core.Response setUserSetting(String setting,
                                                String settingValue)

Save the value of a particular setting for the current user

Parameters:

setting - (Setting name)

settingValue - (Value of the setting)

Returns: