|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PreferenceService
Method Summary | |
---|---|
void |
clearPreferences(java.lang.String userName)
Clears all the preferences for a particular user. |
void |
clearPreferences(java.lang.String userName,
java.lang.String preferenceFilter)
Clears the preferences for a particular user that match the filter optionally provided. |
java.util.Map |
getPreferences(java.lang.String userName)
Get all preferences for a particular user |
java.util.Map |
getPreferences(java.lang.String userName,
java.lang.String preferenceFilter)
Get the preferences for a particular user. |
void |
setPreferences(java.lang.String userName,
java.util.Map preferences)
Sets the preference values for a user. |
Method Detail |
---|
@Auditable(parameters="userName") java.util.Map getPreferences(java.lang.String userName)
userName
- the user name
@Auditable(parameters={"userName", "preferenceFilter"}) java.util.Map getPreferences(java.lang.String userName, java.lang.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", "preferences"}) void setPreferences(java.lang.String userName, java.util.Map 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(java.lang.String userName)
userName
- the user name@Auditable(parameters={"userName", "preferenceFilter"}) void clearPreferences(java.lang.String userName, java.lang.String preferenceFilter)
If no filter if present then all preferences are cleared.
userName
- the user namepreferenceFilter
- the preference filter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |