Package com.liferay.portlet
Class PortletPreferencesFactoryImpl
Object
com.liferay.portlet.PortletPreferencesFactoryImpl
- All Implemented Interfaces:
com.liferay.portal.kernel.portlet.PortletPreferencesFactory
public class PortletPreferencesFactoryImpl
extends Object
implements com.liferay.portal.kernel.portlet.PortletPreferencesFactory
- Author:
- Brian Wing Shun Chan, Alexander Chow, Minhchau Dang, Raymond Augé
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcheckControlPanelPortletPreferences(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, com.liferay.portal.kernel.model.Portlet portlet) static Map<String,Preference> jakarta.portlet.PortletPreferencesfromDefaultXML(String xml) jakarta.portlet.PortletPreferencesgetExistingPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId) jakarta.portlet.PortletPreferencesgetExistingPortletSetup(jakarta.portlet.PortletRequest portletRequest) jakarta.portlet.PortletPreferencesgetLayoutPortletSetup(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) jakarta.portlet.PortletPreferencesgetLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId) jakarta.portlet.PortletPreferencesgetLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId, String defaultPreferences) com.liferay.portal.kernel.portlet.PortalPreferencesgetPortalPreferences(long userId, boolean signedIn) com.liferay.portal.kernel.portlet.PortalPreferencesgetPortalPreferences(jakarta.portlet.PortletRequest portletRequest) com.liferay.portal.kernel.portlet.PortalPreferencesgetPortalPreferences(jakarta.servlet.http.HttpServletRequest httpServletRequest) com.liferay.portal.kernel.portlet.PortalPreferencesgetPortalPreferences(jakarta.servlet.http.HttpSession httpSession, long userId, boolean signedIn) jakarta.portlet.PortletPreferencesgetPortletPreferences(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId) com.liferay.portal.kernel.model.PortletPreferencesIdsgetPortletPreferencesIds(long companyId, long siteGroupId, long layoutGroupId, long plid, String portletId) com.liferay.portal.kernel.model.PortletPreferencesIdsgetPortletPreferencesIds(long companyId, long siteGroupId, long plid, String portletId, String settingsScope) com.liferay.portal.kernel.model.PortletPreferencesIdsgetPortletPreferencesIds(long siteGroupId, long userId, com.liferay.portal.kernel.model.Layout layout, String portletId, boolean modeEditGuest) com.liferay.portal.kernel.model.PortletPreferencesIdsgetPortletPreferencesIds(jakarta.servlet.http.HttpServletRequest httpServletRequest, com.liferay.portal.kernel.model.Layout layout, String portletId) com.liferay.portal.kernel.model.PortletPreferencesIdsgetPortletPreferencesIds(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId) protected jakarta.portlet.PortletPreferencesgetPortletSetup(long companyId, long siteGroupId, long layoutGroupId, long plid, String portletId, String defaultPreferences, boolean strictMode) jakarta.portlet.PortletPreferencesgetPortletSetup(long siteGroupId, com.liferay.portal.kernel.model.Layout layout, String portletId, String defaultPreferences) jakarta.portlet.PortletPreferencesgetPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId, String defaultPreferences) jakarta.portlet.PortletPreferencesgetPortletSetup(jakarta.portlet.PortletRequest portletRequest) jakarta.portlet.PortletPreferencesgetPortletSetup(jakarta.portlet.PortletRequest portletRequest, String portletId) jakarta.portlet.PortletPreferencesgetPortletSetup(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId) jakarta.portlet.PortletPreferencesgetPortletSetup(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId, String defaultPreferences) getPortletSetupMap(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) jakarta.portlet.PortletPreferencesgetPreferences(jakarta.servlet.http.HttpServletRequest httpServletRequest) jakarta.portlet.PreferencesValidatorgetPreferencesValidator(com.liferay.portal.kernel.model.Portlet portlet) jakarta.portlet.PortletPreferencesgetStrictLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId) jakarta.portlet.PortletPreferencesgetStrictPortletSetup(long companyId, long groupId, String portletId) jakarta.portlet.PortletPreferencesgetStrictPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId) protected static PreferencereadPreference(XMLEventReader xmlEventReader) strictFromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml) protected Map<String,Preference> toPreferencesMap(String xml) toXML(com.liferay.portal.kernel.portlet.PortalPreferences portalPreferences) toXML(jakarta.portlet.PortletPreferences portletPreferences)
-
Constructor Details
-
PortletPreferencesFactoryImpl
public PortletPreferencesFactoryImpl()
-
-
Method Details
-
createPreferencesMap
-
checkControlPanelPortletPreferences
public void checkControlPanelPortletPreferences(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, com.liferay.portal.kernel.model.Portlet portlet) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
checkControlPanelPortletPreferencesin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory- Throws:
com.liferay.portal.kernel.exception.PortalException
-
fromDefaultXML
- Specified by:
fromDefaultXMLin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
fromXML
- Specified by:
fromXMLin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
fromXML
public PortletPreferencesImpl fromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml) - Specified by:
fromXMLin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getExistingPortletSetup
public jakarta.portlet.PortletPreferences getExistingPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getExistingPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getExistingPortletSetup
public jakarta.portlet.PortletPreferences getExistingPortletSetup(jakarta.portlet.PortletRequest portletRequest) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getExistingPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLayoutPortletSetup
public jakarta.portlet.PortletPreferences getLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId) - Specified by:
getLayoutPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getLayoutPortletSetup
public jakarta.portlet.PortletPreferences getLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId, String defaultPreferences) - Specified by:
getLayoutPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getLayoutPortletSetup
public jakarta.portlet.PortletPreferences getLayoutPortletSetup(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) - Specified by:
getLayoutPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortalPreferences
public com.liferay.portal.kernel.portlet.PortalPreferences getPortalPreferences(jakarta.servlet.http.HttpServletRequest httpServletRequest) - Specified by:
getPortalPreferencesin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortalPreferences
public com.liferay.portal.kernel.portlet.PortalPreferences getPortalPreferences(jakarta.servlet.http.HttpSession httpSession, long userId, boolean signedIn) - Specified by:
getPortalPreferencesin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortalPreferences
public com.liferay.portal.kernel.portlet.PortalPreferences getPortalPreferences(long userId, boolean signedIn) - Specified by:
getPortalPreferencesin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortalPreferences
public com.liferay.portal.kernel.portlet.PortalPreferences getPortalPreferences(jakarta.portlet.PortletRequest portletRequest) - Specified by:
getPortalPreferencesin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortletPreferences
public jakarta.portlet.PortletPreferences getPortletPreferences(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPortletPreferencesin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPortletPreferencesIds
public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(jakarta.servlet.http.HttpServletRequest httpServletRequest, com.liferay.portal.kernel.model.Layout layout, String portletId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPortletPreferencesIdsin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPortletPreferencesIds
public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPortletPreferencesIdsin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPortletPreferencesIds
public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(long siteGroupId, long userId, com.liferay.portal.kernel.model.Layout layout, String portletId, boolean modeEditGuest) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPortletPreferencesIdsin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPortletPreferencesIds
public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(long companyId, long siteGroupId, long layoutGroupId, long plid, String portletId) throws IllegalArgumentException - Specified by:
getPortletPreferencesIdsin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory- Throws:
IllegalArgumentException
-
getPortletPreferencesIds
public com.liferay.portal.kernel.model.PortletPreferencesIds getPortletPreferencesIds(long companyId, long siteGroupId, long plid, String portletId, String settingsScope) - Specified by:
getPortletPreferencesIdsin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortletSetup
public jakarta.portlet.PortletPreferences getPortletSetup(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId) - Specified by:
getPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortletSetup
public jakarta.portlet.PortletPreferences getPortletSetup(jakarta.servlet.http.HttpServletRequest httpServletRequest, String portletId, String defaultPreferences) - Specified by:
getPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortletSetup
public jakarta.portlet.PortletPreferences getPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId, String defaultPreferences) - Specified by:
getPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortletSetup
public jakarta.portlet.PortletPreferences getPortletSetup(long siteGroupId, com.liferay.portal.kernel.model.Layout layout, String portletId, String defaultPreferences) - Specified by:
getPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortletSetup
public jakarta.portlet.PortletPreferences getPortletSetup(jakarta.portlet.PortletRequest portletRequest) - Specified by:
getPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortletSetup
public jakarta.portlet.PortletPreferences getPortletSetup(jakarta.portlet.PortletRequest portletRequest, String portletId) - Specified by:
getPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPortletSetupMap
public Map<Long,jakarta.portlet.PortletPreferences> getPortletSetupMap(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) - Specified by:
getPortletSetupMapin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPreferences
public jakarta.portlet.PortletPreferences getPreferences(jakarta.servlet.http.HttpServletRequest httpServletRequest) - Specified by:
getPreferencesin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getPreferencesValidator
public jakarta.portlet.PreferencesValidator getPreferencesValidator(com.liferay.portal.kernel.model.Portlet portlet) - Specified by:
getPreferencesValidatorin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getStrictLayoutPortletSetup
public jakarta.portlet.PortletPreferences getStrictLayoutPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId) - Specified by:
getStrictLayoutPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getStrictPortletSetup
public jakarta.portlet.PortletPreferences getStrictPortletSetup(com.liferay.portal.kernel.model.Layout layout, String portletId) - Specified by:
getStrictPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
getStrictPortletSetup
public jakarta.portlet.PortletPreferences getStrictPortletSetup(long companyId, long groupId, String portletId) - Specified by:
getStrictPortletSetupin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
strictFromXML
public StrictPortletPreferencesImpl strictFromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml) - Specified by:
strictFromXMLin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
toXML
- Specified by:
toXMLin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
toXML
- Specified by:
toXMLin interfacecom.liferay.portal.kernel.portlet.PortletPreferencesFactory
-
readPreference
- Throws:
XMLStreamException
-
getPortletSetup
-
toPreferencesMap
-