|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
void |
deletePortletPreferencesByInstance(int userId,
int layoutId,
java.lang.String chanDescId)
Removes portlet preferences for the specific user and instance of a portlet. |
void |
deletePortletPreferencesByUser(int userId)
Removes all portlet preferences stored for the specified user. |
org.apache.pluto.om.common.PreferenceSet |
getDefinitionPreferences(int chanId)
Gets the definition level preferences for the specified channel into an implementation of the PreferenceSet interface. |
org.apache.pluto.om.common.PreferenceSet |
getEntityPreferences(int userId,
int layoutId,
java.lang.String chanDescId)
Gets the enitity level preferences for the specified channel into an implementation of the PreferenceSet interface. |
void |
setDefinitionPreferences(int chanId,
org.apache.pluto.om.common.PreferenceSet prefs)
Stores the definition level preferences described by the PreferenceSet interface. |
void |
setEntityPreferences(int userId,
int layoutId,
java.lang.String chanDescId,
org.apache.pluto.om.common.PreferenceSet prefs)
Stores the entity level preferences described by the PreferenceSet interface. |
Method Detail |
public void setDefinitionPreferences(int chanId, org.apache.pluto.om.common.PreferenceSet prefs) throws java.lang.Exception
chanId
- The id of the channel to store the preferences for.prefs
- The PreferenceSet which describes the data to store.
java.lang.Exception
- If any error occurs while storing the data.public org.apache.pluto.om.common.PreferenceSet getDefinitionPreferences(int chanId) throws java.lang.Exception
chanId
- The id of the channel to get the preferences for.
java.lang.Exception
- If any error occurs while getting the data.public void setEntityPreferences(int userId, int layoutId, java.lang.String chanDescId, org.apache.pluto.om.common.PreferenceSet prefs) throws java.lang.Exception
userId
- The id of the user to store the preferences for.layoutId
- The layout fragment id to store the preferences for.chanDescId
- The structure id to store the preferences for.prefs
- The PreferenceSet which describes the data to store.
java.lang.Exception
- If any error occurs while storing the data.public org.apache.pluto.om.common.PreferenceSet getEntityPreferences(int userId, int layoutId, java.lang.String chanDescId) throws java.lang.Exception
userId
- The id of the user to get the preferences for.layoutId
- The layout fragment id to get the preferences for.chanDescId
- The structure id to get the preferences for.
java.lang.Exception
- If any error occurs while getting the data.public void deletePortletPreferencesByUser(int userId) throws java.lang.Exception
userId
- The id of the user to remove the preferences for.
java.lang.Exception
- If any error occurs while removing the data.public void deletePortletPreferencesByInstance(int userId, int layoutId, java.lang.String chanDescId) throws java.lang.Exception
userId
- The id of the user to remove the preferences for.layoutId
- The layout fragment id to remove the preferences for.chanDescId
- The structure id to remove the preferences for.
java.lang.Exception
- If any error occurs while removing the data.
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |