org.onosproject.ui

Interface UiPreferencesService

public interface UiPreferencesService

Service for tracking user interface preferences.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode>	getPreferences(java.lang.String userName) Returns an immutable copy of the preferences for the specified user.
java.util.Set<java.lang.String>	getUserNames() Returns the list of user names that have user preferences available.
void	setPreference(java.lang.String userName, java.lang.String preference, com.fasterxml.jackson.databind.node.ObjectNode value) Sets the named preference for the specified user.

Method Detail

getUserNames

java.util.Set<java.lang.String> getUserNames()

Returns the list of user names that have user preferences available.

Returns:

list of user names

getPreferences

java.util.Map<java.lang.String,com.fasterxml.jackson.databind.node.ObjectNode> getPreferences(java.lang.String userName)

Returns an immutable copy of the preferences for the specified user.

Parameters:

userName - user name

Returns:

map of user preferences

setPreference

void setPreference(java.lang.String userName,
                   java.lang.String preference,
                   com.fasterxml.jackson.databind.node.ObjectNode value)

Sets the named preference for the specified user.

Parameters:

userName - user name

preference - name of the user preference

value - preference value