Interface PortletPreferencesFactory
@ProviderType
public interface PortletPreferencesFactory
- Author:
- Brian Wing Shun Chan
-
Method Summary
Modifier and TypeMethodDescriptionvoid
checkControlPanelPortletPreferences
(ThemeDisplay themeDisplay, Portlet portlet) fromDefaultXML
(String xml) getExistingPortletSetup
(Layout layout, String portletId) getExistingPortletSetup
(PortletRequest portletRequest) getLayoutPortletSetup
(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) getLayoutPortletSetup
(Layout layout, String portletId) getLayoutPortletSetup
(Layout layout, String portletId, String defaultPreferences) getPortalPreferences
(long userId, boolean signedIn) getPortalPreferences
(PortletRequest portletRequest) getPortalPreferences
(javax.servlet.http.HttpServletRequest httpServletRequest) getPortalPreferences
(javax.servlet.http.HttpSession httpSession, long userId, boolean signedIn) getPortletPreferences
(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId) getPortletPreferencesIds
(long companyId, long siteGroupId, long layoutGroupId, long plid, String portletId) getPortletPreferencesIds
(long companyId, long siteGroupId, long plid, String portletId, String settingsScope) getPortletPreferencesIds
(long scopeGroupId, long userId, Layout layout, String portletId, boolean modeEditGuest) getPortletPreferencesIds
(javax.servlet.http.HttpServletRequest httpServletRequest, Layout selLayout, String portletId) getPortletPreferencesIds
(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId) getPortletSetup
(long scopeGroupId, Layout layout, String portletId, String defaultPreferences) getPortletSetup
(Layout layout, String portletId, String defaultPreferences) getPortletSetup
(PortletRequest portletRequest) getPortletSetup
(PortletRequest portletRequest, String portletId) getPortletSetup
(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId) getPortletSetup
(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId, String defaultPreferences) getPortletSetupMap
(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) getPreferences
(javax.servlet.http.HttpServletRequest httpServletRequest) getPreferencesValidator
(Portlet portlet) getStrictLayoutPortletSetup
(Layout layout, String portletId) getStrictPortletSetup
(long companyId, long groupId, String portletId) getStrictPortletSetup
(Layout layout, String portletId) strictFromXML
(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml) toXML
(PortalPreferences portalPreferences) toXML
(PortletPreferences portletPreferences)
-
Method Details
-
checkControlPanelPortletPreferences
void checkControlPanelPortletPreferences(ThemeDisplay themeDisplay, Portlet portlet) throws PortalException - Throws:
PortalException
-
fromDefaultXML
-
fromXML
-
fromXML
PortletPreferences fromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml) -
getExistingPortletSetup
- Throws:
PortalException
-
getExistingPortletSetup
- Throws:
PortalException
-
getLayoutPortletSetup
-
getLayoutPortletSetup
PortletPreferences getLayoutPortletSetup(Layout layout, String portletId, String defaultPreferences) -
getLayoutPortletSetup
PortletPreferences getLayoutPortletSetup(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) -
getPortalPreferences
-
getPortalPreferences
PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession httpSession, long userId, boolean signedIn) -
getPortalPreferences
-
getPortalPreferences
-
getPortletPreferences
PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId) throws PortalException - Throws:
PortalException
-
getPortletPreferencesIds
PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest httpServletRequest, Layout selLayout, String portletId) throws PortalException - Throws:
PortalException
-
getPortletPreferencesIds
PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId) throws PortalException - Throws:
PortalException
-
getPortletPreferencesIds
PortletPreferencesIds getPortletPreferencesIds(long scopeGroupId, long userId, Layout layout, String portletId, boolean modeEditGuest) throws PortalException - Throws:
PortalException
-
getPortletPreferencesIds
PortletPreferencesIds getPortletPreferencesIds(long companyId, long siteGroupId, long layoutGroupId, long plid, String portletId) throws IllegalArgumentException - Throws:
IllegalArgumentException
-
getPortletPreferencesIds
PortletPreferencesIds getPortletPreferencesIds(long companyId, long siteGroupId, long plid, String portletId, String settingsScope) -
getPortletSetup
PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId) throws PortalException - Throws:
PortalException
-
getPortletSetup
PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId, String defaultPreferences) throws PortalException - Throws:
PortalException
-
getPortletSetup
-
getPortletSetup
PortletPreferences getPortletSetup(long scopeGroupId, Layout layout, String portletId, String defaultPreferences) -
getPortletSetup
- Throws:
PortalException
-
getPortletSetup
PortletPreferences getPortletSetup(PortletRequest portletRequest, String portletId) throws PortalException - Throws:
PortalException
-
getPortletSetupMap
Map<Long,PortletPreferences> getPortletSetupMap(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) -
getPreferences
-
getPreferencesValidator
-
getStrictLayoutPortletSetup
-
getStrictPortletSetup
-
getStrictPortletSetup
-
strictFromXML
PortletPreferences strictFromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml) -
toXML
-
toXML
-