Liferay 7.0-ce-b4

com.liferay.portlet
Interface PortletPreferencesFactory


@ProviderType
public interface PortletPreferencesFactory


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

Method Detail

checkControlPanelPortletPreferences

void checkControlPanelPortletPreferences(ThemeDisplay themeDisplay,
                                         Portlet portlet)
                                         throws PortalException
Throws:
PortalException

fromDefaultXML

PortletPreferences fromDefaultXML(String xml)

fromXML

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

fromXML

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

fromXML

@Deprecated
PortalPreferences fromXML(long companyId,
                                     long ownerId,
                                     int ownerType,
                                     String xml)
Deprecated. As of 6.2.0, replaced by fromXML(long, int, String)


getExistingPortletSetup

PortletPreferences getExistingPortletSetup(Layout layout,
                                           String portletId)
                                           throws PortalException
Throws:
PortalException

getExistingPortletSetup

PortletPreferences getExistingPortletSetup(PortletRequest portletRequest)
                                           throws PortalException
Throws:
PortalException

getLayoutPortletSetup

PortletPreferences getLayoutPortletSetup(Layout layout,
                                         String portletId)

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

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

getPortalPreferences

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

getPortalPreferences

@Deprecated
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)


getPortalPreferences

PortalPreferences getPortalPreferences(long userId,
                                       boolean signedIn)

getPortalPreferences

@Deprecated
PortalPreferences getPortalPreferences(long companyId,
                                                  long userId,
                                                  boolean signedIn)
Deprecated. As of 6.2.0, replaced by getPortalPreferences(long, boolean)


getPortalPreferences

PortalPreferences getPortalPreferences(PortletRequest portletRequest)

getPortletPreferences

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

getPortletPreferencesIds

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

getPortletPreferencesIds

PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request,
                                               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 plid,
                                               String portletId,
                                               String settingsScope)

getPortletSetup

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

getPortletSetup

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

getPortletSetup

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

getPortletSetup

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

getPortletSetup

PortletPreferences getPortletSetup(PortletRequest portletRequest)
                                   throws PortalException
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

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

getPreferencesValidator

PreferencesValidator getPreferencesValidator(Portlet portlet)

getStrictLayoutPortletSetup

PortletPreferences getStrictLayoutPortletSetup(Layout layout,
                                               String portletId)

getStrictPortletSetup

PortletPreferences getStrictPortletSetup(Layout layout,
                                         String portletId)

getStrictPortletSetup

PortletPreferences getStrictPortletSetup(long companyId,
                                         long groupId,
                                         String portletId)

strictFromXML

PortletPreferences strictFromXML(long companyId,
                                 long ownerId,
                                 int ownerType,
                                 long plid,
                                 String portletId,
                                 String xml)

toXML

String toXML(PortalPreferences portalPreferences)

toXML

String toXML(PortletPreferences portletPreferences)

Liferay 7.0-ce-b4