Package com.jalios.jcms.memberpreference
Class MemberPreferenceManager
java.lang.Object
com.jalios.jcms.memberpreference.MemberPreferenceManager
- All Implemented Interfaces:
DBConstants,JPropertiesListener
-
Field Summary
FieldsFields inherited from interface com.jalios.jcms.db.DBConstants
ALL_CATEGORIES_SET_FIELD, ATTACH_WS_SET_FIELD, AUTH_GRP_SET_FIELD, AUTH_MBR_SET_FIELD, AUTHOR_ID_FIELD, CATEGORIES_SET_FIELD, CDATE_FIELD, CHANNEL_JCMSDB_PROP, CLASSIFICATION_LEVEL_FIELD, DBDATA_URID, EXTENDED_READ_RIGHTS, HAS_ATTACH_WS_FIELD, HAS_NO_READ_RIGHTS, HIBERNATE_MAPPING_ADATE, HIBERNATE_MAPPING_AUTHOR, HIBERNATE_MAPPING_CDATE, HIBERNATE_MAPPING_EDATE, HIBERNATE_MAPPING_HAS_ATTACH_WS, HIBERNATE_MAPPING_HASNOREADRIGHTS, HIBERNATE_MAPPING_MAININSTANCE_ID, HIBERNATE_MAPPING_MAJORVERSION, HIBERNATE_MAPPING_MDATE, HIBERNATE_MAPPING_MERGE_DATE, HIBERNATE_MAPPING_MERGE_ID, HIBERNATE_MAPPING_MINORVERSION, HIBERNATE_MAPPING_OPAUTHOR, HIBERNATE_MAPPING_PDATE, HIBERNATE_MAPPING_PSTATUS, HIBERNATE_MAPPING_READ_ACK, HIBERNATE_MAPPING_READERCOUNT, HIBERNATE_MAPPING_RESTRICTIVE_UPDATE_RIGHTS, HIBERNATE_MAPPING_TITLE, HIBERNATE_MAPPING_TRACKED, HIBERNATE_MAPPING_UDATE, HIBERNATE_MAPPING_VOTECOUNT, HIBERNATE_MAPPING_VOTESCORE, HIBERNATE_MAPPING_WORKFLOW_ID, HIBERNATE_MAPPING_WORKSPACE_ID, MAX_HIBERNATE_MAPPING_PUBLICATION, MDATE_FIELD, OPAUTHOR_ID_FIELD, PSTATUS_FIELD, ROW_ID_FIELD, SCROLL_FETCH_SIZE, WORKFLOW_ID_FIELD, WORKSPACE_ID_FIELD -
Method Summary
Modifier and TypeMethodDescriptionReturns all the default MemberPreference.Method that returns default memberprefences This method does not include cached memberpreferencesReturns the default value for the given preferencestatic MemberPreferenceManagerReturns all the MemberPreference of the given member.getPreference(Member mbr, String key) Returns the given preference for the given member (use default if any)getPreference(Member mbr, String key, boolean useDefault) Returns the given preference for the given memberbooleanhasMemberPreference(Member mbr, String key) voidpropertiesChange(JProperties properties) Invoked after properties have been modified in JCMS and save on disk.voidRemove all the preferences of the given member.voidremovePreference(Member mbr, String key) Remove a member preference for a given membervoidReset the cache.voidsaveDefaultPreference(String key, String value) voidsavePreference(Member mbr, String key, String value) Save the preference (key/value) for the given member.
-
Field Details
-
PROPERTY_PREFIX
- See Also:
-
CACHE_ENABLED_PROP
- See Also:
-
CACHE_MAX_ENTRIES_PROP
- See Also:
-
-
Method Details
-
getInstance
-
propertiesChange
Description copied from interface:JPropertiesListenerInvoked after properties have been modified in JCMS and save on disk.You cannot alter the value received in parameters.
Note that properties parameter may be null, a limited set of site properties, or all site properties.
To check that a property has been modified, reload the "current" property instead using
channel.getPropertiesorchannel.getProperty.- Specified by:
propertiesChangein interfaceJPropertiesListener- Parameters:
properties- the properties which have been submitted to change
-
getPreference
Returns the given preference for the given member (use default if any)- Parameters:
mbr- the memberkey- the key of the preference- Returns:
- the given preference for the given member
- Since:
- jcms-10.0.0
-
getPreference
Returns the given preference for the given member- Parameters:
mbr- the memberkey- the key of the preferenceuseDefault- if true and there is no preference fo the given member, search for a default preference- Returns:
- the given preference for the given member
- Since:
- jcms-10.0.0
-
getDefaultPreference
Returns the default value for the given preference- Parameters:
key- the key of the preference- Returns:
- the given preference for the given member
- Since:
- jcms-10.0.0
-
getMemberPreferenceList
Returns all the MemberPreference of the given member.- Parameters:
mbr- the member.- Returns:
- all the MemberPreference of the given member.
- Since:
- jcms-10.0.0
-
savePreference
Save the preference (key/value) for the given member.- Parameters:
mbr- the memberkey- the key of the preferencevalue- the value of the preference- Since:
- jcms-10.0.0
-
saveDefaultPreference
-
removeAllPreferences
Remove all the preferences of the given member.- Parameters:
mbr- the member- Since:
- jcms-10.0.0
-
removePreference
Remove a member preference for a given member- Parameters:
mbr- the memberkey- the key of the preference- Since:
- jcms-10.0.3
-
resetCache
public void resetCache()Reset the cache. A new cache is initialized.- Since:
- jcms-10.0.1
-
hasMemberPreference
-
getDefaultMemberPreferences
Method that returns default memberprefences This method does not include cached memberpreferences- Returns:
-
getDefaultMemberPreferenceList
Returns all the default MemberPreference.- Returns:
- all the default MemberPreference.
- Since:
- jcms-10.0.8
-