com.liferay.portlet
Interface PortletPreferencesFactory

All Known Implementing Classes:

PortletPreferencesFactoryImpl

@ProviderType
public interface PortletPreferencesFactory

Method Summary

abstract void	checkControlPanelPortletPreferences(ThemeDisplay themeDisplay, Portlet portlet)
abstract PortletPreferences	fromDefaultXML(String xml)
abstract PortalPreferences	fromXML(long ownerId, int ownerType, String xml)
abstract PortletPreferences	fromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml)
abstract PortalPreferences	fromXML(long companyId, long ownerId, int ownerType, String xml) Deprecated. As of 6.2.0, replaced by fromXML(long, int, String)
abstract PortletPreferences	getLayoutPortletSetup(Layout layout, String portletId)
abstract PortalPreferences	getPortalPreferences(javax.servlet.http.HttpServletRequest request)
abstract PortalPreferences	getPortalPreferences(javax.servlet.http.HttpSession session, long userId, boolean signedIn)
abstract PortalPreferences	getPortalPreferences(javax.servlet.http.HttpSession session, long companyId, long userId, boolean signedIn) Deprecated. As of 6.2.0, replaced by getPortalPreferences(HttpSession, long, boolean)
abstract PortalPreferences	getPortalPreferences(long userId, boolean signedIn)
abstract PortalPreferences	getPortalPreferences(long companyId, long userId, boolean signedIn) Deprecated. As of 6.2.0, replaced by getPortalPreferences(long, boolean)
abstract PortalPreferences	getPortalPreferences(PortletRequest portletRequest)
abstract PortletPreferences	getPortletPreferences(javax.servlet.http.HttpServletRequest request, String portletId)
abstract PortletPreferencesIds	getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, Layout selLayout, String portletId)
abstract PortletPreferencesIds	getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, String portletId)
abstract PortletPreferencesIds	getPortletPreferencesIds(long scopeGroupId, long userId, Layout layout, String portletId, boolean modeEditGuest)
abstract PortletPreferences	getPortletSetup(javax.servlet.http.HttpServletRequest request, String portletId)
abstract PortletPreferences	getPortletSetup(javax.servlet.http.HttpServletRequest request, String portletId, String defaultPreferences)
abstract PortletPreferences	getPortletSetup(Layout layout, String portletId, String defaultPreferences)
abstract PortletPreferences	getPortletSetup(long scopeGroupId, Layout layout, String portletId, String defaultPreferences)
abstract PortletPreferences	getPortletSetup(PortletRequest portletRequest)
abstract PortletPreferences	getPortletSetup(PortletRequest portletRequest, String portletId)
abstract Map<Long,PortletPreferences>	getPortletSetupMap(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout)
abstract PortletPreferences	getPreferences(javax.servlet.http.HttpServletRequest request)
abstract PreferencesValidator	getPreferencesValidator(Portlet portlet)
abstract PortletPreferences	getStrictLayoutPortletSetup(Layout layout, String portletId)
abstract PortletPreferences	getStrictPortletSetup(Layout layout, String portletId)
abstract String	toXML(PortalPreferences portalPreferences)
abstract String	toXML(PortletPreferences portletPreferences)

Method Detail

checkControlPanelPortletPreferences

void checkControlPanelPortletPreferences(ThemeDisplay themeDisplay,
                                         Portlet portlet)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

fromDefaultXML

PortletPreferences fromDefaultXML(String xml)
                                  throws SystemException

Throws:

SystemException

fromXML

PortalPreferences fromXML(long ownerId,
                          int ownerType,
                          String xml)
                          throws SystemException

Throws:

SystemException

fromXML

PortletPreferences fromXML(long companyId,
                           long ownerId,
                           int ownerType,
                           long plid,
                           String portletId,
                           String xml)
                           throws SystemException

Throws:

SystemException

fromXML

PortalPreferences fromXML(long companyId,
                          long ownerId,
                          int ownerType,
                          String xml)
                          throws SystemException

Deprecated. As of 6.2.0, replaced by fromXML(long, int, String)

Throws:

SystemException

getLayoutPortletSetup

PortletPreferences getLayoutPortletSetup(Layout layout,
                                         String portletId)
                                         throws SystemException

Throws:

SystemException

getPortalPreferences

PortalPreferences getPortalPreferences(javax.servlet.http.HttpServletRequest request)
                                       throws SystemException

Throws:

SystemException

getPortalPreferences

PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession session,
                                       long userId,
                                       boolean signedIn)
                                       throws SystemException

Throws:

SystemException

getPortalPreferences

PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession session,
                                       long companyId,
                                       long userId,
                                       boolean signedIn)
                                       throws SystemException

Deprecated. As of 6.2.0, replaced by getPortalPreferences(HttpSession, long, boolean)

Throws:

SystemException

getPortalPreferences

PortalPreferences getPortalPreferences(long userId,
                                       boolean signedIn)
                                       throws SystemException

Throws:

SystemException

getPortalPreferences

PortalPreferences getPortalPreferences(long companyId,
                                       long userId,
                                       boolean signedIn)
                                       throws SystemException

Deprecated. As of 6.2.0, replaced by getPortalPreferences(long, boolean)

Throws:

SystemException

getPortalPreferences

PortalPreferences getPortalPreferences(PortletRequest portletRequest)
                                       throws SystemException

Throws:

SystemException

getPortletPreferences

PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest request,
                                         String portletId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getPortletPreferencesIds

PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request,
                                               Layout selLayout,
                                               String portletId)
                                               throws PortalException,
                                                      SystemException

Throws:

PortalException

SystemException

getPortletPreferencesIds

PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request,
                                               String portletId)
                                               throws PortalException,
                                                      SystemException

Throws:

PortalException

SystemException

getPortletPreferencesIds

PortletPreferencesIds getPortletPreferencesIds(long scopeGroupId,
                                               long userId,
                                               Layout layout,
                                               String portletId,
                                               boolean modeEditGuest)
                                               throws PortalException,
                                                      SystemException

Throws:

PortalException

SystemException

getPortletSetup

PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request,
                                   String portletId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getPortletSetup

PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request,
                                   String portletId,
                                   String defaultPreferences)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getPortletSetup

PortletPreferences getPortletSetup(Layout layout,
                                   String portletId,
                                   String defaultPreferences)
                                   throws SystemException

Throws:

SystemException

getPortletSetup

PortletPreferences getPortletSetup(long scopeGroupId,
                                   Layout layout,
                                   String portletId,
                                   String defaultPreferences)
                                   throws SystemException

Throws:

SystemException

getPortletSetup

PortletPreferences getPortletSetup(PortletRequest portletRequest)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getPortletSetup

PortletPreferences getPortletSetup(PortletRequest portletRequest,
                                   String portletId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getPortletSetupMap

Map<Long,PortletPreferences> getPortletSetupMap(long companyId,
                                                long groupId,
                                                long ownerId,
                                                int ownerType,
                                                String portletId,
                                                boolean privateLayout)
                                                throws SystemException

Throws:

SystemException

getPreferences

PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)

getPreferencesValidator

PreferencesValidator getPreferencesValidator(Portlet portlet)

getStrictLayoutPortletSetup

PortletPreferences getStrictLayoutPortletSetup(Layout layout,
                                               String portletId)
                                               throws SystemException

Throws:

SystemException

getStrictPortletSetup

PortletPreferences getStrictPortletSetup(Layout layout,
                                         String portletId)
                                         throws SystemException

Throws:

SystemException

toXML

String toXML(PortalPreferences portalPreferences)

toXML

String toXML(PortletPreferences portletPreferences)