| org.jasig.portal.IPortletPreferencesStore
All known Subclasses: org.jasig.portal.RDBMPortletPreferencesStore, org.jasig.portal.StubPortletPreferencesStore,
| IPortletPreferencesStore | | public interface IPortletPreferencesStore (Code) | | The IPortletPreferenceStore allows a portlet to atomicly persist preferences at two
different levels. Definition level preferences are common to all instances of a
channel. Entity level preferences are specific for on a per user per instance basis.
author:
Eric Dalquist edalquist@unicon.net
version:
$Revision: 34809 $ |
| Method Summary | |
| abstract public void | deletePortletPreferencesByInstance(int userId, int layoutId, String chanDescId)
Removes portlet preferences for the specific user and instance of a portlet. | | abstract public void | deletePortletPreferencesByUser(int userId)
Removes all portlet preferences stored for the specified user. | | abstract public PreferenceSet | getDefinitionPreferences(int chanId)
Gets the definition level preferences for the specified channel into an
implementation of the PreferenceSet interface. | | abstract public PreferenceSet | getEntityPreferences(int userId, int layoutId, String chanDescId)
Gets the enitity level preferences for the specified channel into an
implementation of the PreferenceSet interface. | | abstract public void | setDefinitionPreferences(int chanId, PreferenceSet prefs)
Stores the definition level preferences described by the PreferenceSet
interface. | | abstract public void | setEntityPreferences(int userId, int layoutId, String chanDescId, PreferenceSet prefs)
Stores the entity level preferences described by the PreferenceSet
interface. |
| deletePortletPreferencesByInstance | | abstract public void deletePortletPreferencesByInstance(int userId, int layoutId, String chanDescId) throws Exception(Code) | | Removes portlet preferences for the specific user and instance of a portlet.
Parameters:
userId - The id of the user to remove the preferences for.
Parameters:
layoutId - The layout fragment id to remove the preferences for.
Parameters:
chanDescId - The structure id to remove the preferences for.
throws:
Exception - If any error occurs while removing the data. |
| deletePortletPreferencesByUser | | abstract public void deletePortletPreferencesByUser(int userId) throws Exception(Code) | | Removes all portlet preferences stored for the specified user.
Parameters:
userId - The id of the user to remove the preferences for.
throws:
Exception - If any error occurs while removing the data. |
| getDefinitionPreferences | | abstract public PreferenceSet getDefinitionPreferences(int chanId) throws Exception(Code) | | Gets the definition level preferences for the specified channel into an
implementation of the PreferenceSet interface.
Parameters:
chanId - The id of the channel to get the preferences for. An implementation of the PreferenceSet interface that contains the preferences.
throws:
Exception - If any error occurs while getting the data. |
| getEntityPreferences | | abstract public PreferenceSet getEntityPreferences(int userId, int layoutId, String chanDescId) throws Exception(Code) | | Gets the enitity level preferences for the specified channel into an
implementation of the PreferenceSet interface. The userId, layoutId and
structId make up the primary key for the preferences.
Parameters:
userId - The id of the user to get the preferences for.
Parameters:
layoutId - The layout fragment id to get the preferences for.
Parameters:
chanDescId - The structure id to get the preferences for. An implementation of the PreferenceSet interface that contains the preferences.
throws:
Exception - If any error occurs while getting the data. |
| setDefinitionPreferences | | abstract public void setDefinitionPreferences(int chanId, PreferenceSet prefs) throws Exception(Code) | | Stores the definition level preferences described by the PreferenceSet
interface. The store operation is atomic, it can be assumed that if the
method completes with no exception being thrown the store was successfull.
If an exception is thrown it can be assumed that no changes were made to
the underlying persistant store.
Parameters:
chanId - The id of the channel to store the preferences for.
Parameters:
prefs - The PreferenceSet which describes the data to store.
throws:
Exception - If any error occurs while storing the data. |
| setEntityPreferences | | abstract public void setEntityPreferences(int userId, int layoutId, String chanDescId, PreferenceSet prefs) throws Exception(Code) | | Stores the entity level preferences described by the PreferenceSet
interface. The store operation is atomic, it can be assumed that if the
method completes with no exception being thrown the store was successfull.
If an exception is thrown it can be assumed that no changes were made to
the underlying persistant store. The userId, layoutId and structId make up
the primary key for the preferences.
Parameters:
userId - The id of the user to store the preferences for.
Parameters:
layoutId - The layout fragment id to store the preferences for.
Parameters:
chanDescId - The structure id to store the preferences for.
Parameters:
prefs - The PreferenceSet which describes the data to store.
throws:
Exception - If any error occurs while storing the data. |
|
|