Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.service.cmr.preference
Interface PreferenceService

public interface PreferenceService
Author:
Roy Wetherall

Method Summary
void
clearPreferences(String userName)
          Clears all the preferences for a particular user.
void
clearPreferences(String userName, String preferenceFilter)
          Clears the preferences for a particular user that match the filter optionally provided.
getPagedPreferences(String userName, String preferenceFilter, PagingRequest pagingRequest)
getPreference(String userName, String preferenceName)
getPreferences(String userName)
          Get all preferences for a particular user
getPreferences(String userName, String preferenceFilter)
          Get the preferences for a particular user.
void
setPreferences(String userName, Map<String,Serializable> preferences)
          Sets the preference values for a user.
Method Detail
getPreferences
@Auditable(parameters="userName")
Map<String,SerializablegetPreferences(String userName)
Get all preferences for a particular user
Parameters:
userName - the user name
Returns:
a map containing the preference values, empty if none

getPreference
@Auditable(parameters={
  "userName",
  "preferenceName"
})
Serializable getPreference(String userName,
                           String preferenceName)

getPreferences
@Auditable(parameters={
  "userName",
  "preferenceFilter"
})
Map<String,SerializablegetPreferences(String userName,
                                        String preferenceFilter)
Get the preferences for a particular user.

If no filter if provided all preferences are returned.

If a filter is provided it's used to filter the results. For example the filter "alfresco.myComp" will only return filters that are in the "namespace" alfresco.myComp.

Parameters:
userName - the user name
preferenceFilter - the preference filter
Returns:
a map containing the preference values, empty if none

getPagedPreferences
@Auditable(parameters={
  "userName",
  "preferenceFilter"
})
PagingResults<Pair<String,Serializable>> getPagedPreferences(String userName,
                                                             String preferenceFilter,
                                                             PagingRequest pagingRequest)

setPreferences
@Auditable(parameters={
  "userName",
  "preferences"
})
void setPreferences(String userName,
                    Map<String,Serializable> preferences)
Sets the preference values for a user.

Values provided overlay those already present.

Preference value names can be "namespaced" by using package notation. For example "alfresc.myComp.myValue".

Parameters:
userName - the user name
preferences - the preference values

clearPreferences
@Auditable(parameters="userName")
void clearPreferences(String userName)
Clears all the preferences for a particular user.
Parameters:
userName - the user name

clearPreferences
@Auditable(parameters={
  "userName",
  "preferenceFilter"
})
void clearPreferences(String userName,
                      String preferenceFilter)
Clears the preferences for a particular user that match the filter optionally provided.

If no filter if present then all preferences are cleared.

Parameters:
userName - the user name
preferenceFilter - the preference filter

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2016 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.