@AlfrescoPublicApi
public interface PreferenceService
Modifier and Type | Method and Description |
---|---|
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.
|
org.alfresco.query.PagingResults<org.alfresco.util.Pair<String,Serializable>> |
getPagedPreferences(String userName,
String preferenceFilter,
org.alfresco.query.PagingRequest pagingRequest) |
Serializable |
getPreference(String userName,
String preferenceName) |
Map<String,Serializable> |
getPreferences(String userName)
Get all preferences for a particular user
|
Map<String,Serializable> |
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.
|
@Auditable(parameters="userName") Map<String,Serializable> getPreferences(String userName)
userName
- the user name@Auditable(parameters={"userName","preferenceName"}) Serializable getPreference(String userName, String preferenceName)
@Auditable(parameters={"userName","preferenceFilter"}) Map<String,Serializable> getPreferences(String userName, String preferenceFilter)
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.
userName
- the user namepreferenceFilter
- the preference filter@Auditable(parameters={"userName","preferenceFilter"}) org.alfresco.query.PagingResults<org.alfresco.util.Pair<String,Serializable>> getPagedPreferences(String userName, String preferenceFilter, org.alfresco.query.PagingRequest pagingRequest)
@Auditable(parameters={"userName","preferences"}) void setPreferences(String userName, Map<String,Serializable> preferences)
Values provided overlay those already present.
Preference value names can be "namespaced" by using package notation. For example "alfresc.myComp.myValue".
userName
- the user namepreferences
- the preference values@Auditable(parameters="userName") void clearPreferences(String userName)
userName
- the user name@Auditable(parameters={"userName","preferenceFilter"}) void clearPreferences(String userName, String preferenceFilter)
If no filter if present then all preferences are cleared.
userName
- the user namepreferenceFilter
- the preference filterCopyright © 2005–2017 Alfresco Software. All rights reserved.