Liferay 7.0-ce-b4

com.liferay.portlet
Class PortletPreferencesFactoryUtil

java.lang.Object
  extended by com.liferay.portlet.PortletPreferencesFactoryUtil

@ProviderType
public class PortletPreferencesFactoryUtil
extends Object


Constructor Summary
PortletPreferencesFactoryUtil()
           
 
Method Summary
static void checkControlPanelPortletPreferences(ThemeDisplay themeDisplay, Portlet portlet)
           
static PortletPreferences fromDefaultXML(String xml)
           
static PortalPreferences fromXML(long ownerId, int ownerType, String xml)
           
static PortletPreferences fromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml)
           
static PortalPreferences fromXML(long companyId, long ownerId, int ownerType, String xml)
          Deprecated. As of 6.2.0, replaced by fromXML(long, int, String)
static PortletPreferences getExistingPortletSetup(Layout layout, String portletId)
           
static PortletPreferences getExistingPortletSetup(PortletRequest portletRequest)
           
static PortletPreferences getLayoutPortletSetup(Layout layout, String portletId)
           
static PortletPreferences getLayoutPortletSetup(Layout layout, String portletId, String defaultPreferences)
           
static PortletPreferences getLayoutPortletSetup(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences)
           
static PortalPreferences getPortalPreferences(javax.servlet.http.HttpServletRequest request)
           
static PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession session, long userId, boolean signedIn)
           
static 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)
static PortalPreferences getPortalPreferences(long userId, boolean signedIn)
           
static PortalPreferences getPortalPreferences(long companyId, long userId, boolean signedIn)
          Deprecated. As of 6.2.0, replaced by getPortalPreferences(long, boolean)
static PortalPreferences getPortalPreferences(PortletRequest portletRequest)
           
static PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest request, String portletId)
           
static PortletPreferencesFactory getPortletPreferencesFactory()
           
static PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, Layout selLayout, String portletId)
           
static PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, String portletId)
           
static PortletPreferencesIds getPortletPreferencesIds(long siteGroupId, long userId, Layout layout, String portletId, boolean modeEditGuest)
           
static PortletPreferencesIds getPortletPreferencesIds(long companyId, long siteGroupId, long plid, String portletId, String settingsScope)
           
static PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request, String portletId)
           
static PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request, String portletId, String defaultPreferences)
           
static PortletPreferences getPortletSetup(Layout layout, String portletId, String defaultPreferences)
           
static PortletPreferences getPortletSetup(long siteGroupId, Layout layout, String portletId, String defaultPreferences)
           
static PortletPreferences getPortletSetup(PortletRequest portletRequest)
           
static PortletPreferences getPortletSetup(PortletRequest portletRequest, String portletId)
           
static Map<Long,PortletPreferences> getPortletSetupMap(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout)
           
static PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)
           
static PreferencesValidator getPreferencesValidator(Portlet portlet)
           
static PortletPreferences getStrictLayoutPortletSetup(Layout layout, String portletId)
           
static PortletPreferences getStrictPortletSetup(Layout layout, String portletId)
           
static PortletPreferences getStrictPortletSetup(long companyId, long groupId, String portletId)
           
 void setPortletPreferencesFactory(PortletPreferencesFactory portletPreferencesFactory)
           
static PortletPreferences strictFromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml)
           
static String toXML(PortalPreferences portalPreferences)
           
static String toXML(PortletPreferences portletPreferences)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletPreferencesFactoryUtil

public PortletPreferencesFactoryUtil()
Method Detail

checkControlPanelPortletPreferences

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

fromDefaultXML

public static PortletPreferences fromDefaultXML(String xml)

fromXML

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

fromXML

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

fromXML

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


getExistingPortletSetup

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

getExistingPortletSetup

public static PortletPreferences getExistingPortletSetup(PortletRequest portletRequest)
                                                  throws PortalException
Throws:
PortalException

getLayoutPortletSetup

public static PortletPreferences getLayoutPortletSetup(Layout layout,
                                                       String portletId)

getLayoutPortletSetup

public static PortletPreferences getLayoutPortletSetup(Layout layout,
                                                       String portletId,
                                                       String defaultPreferences)

getLayoutPortletSetup

public static PortletPreferences getLayoutPortletSetup(long companyId,
                                                       long ownerId,
                                                       int ownerType,
                                                       long plid,
                                                       String portletId,
                                                       String defaultPreferences)

getPortalPreferences

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

getPortalPreferences

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

getPortalPreferences

@Deprecated
public static 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

public static PortalPreferences getPortalPreferences(long userId,
                                                     boolean signedIn)

getPortalPreferences

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


getPortalPreferences

public static PortalPreferences getPortalPreferences(PortletRequest portletRequest)

getPortletPreferences

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

getPortletPreferencesFactory

public static PortletPreferencesFactory getPortletPreferencesFactory()

getPortletPreferencesIds

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

getPortletPreferencesIds

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

getPortletPreferencesIds

public static PortletPreferencesIds getPortletPreferencesIds(long siteGroupId,
                                                             long userId,
                                                             Layout layout,
                                                             String portletId,
                                                             boolean modeEditGuest)
                                                      throws PortalException
Throws:
PortalException

getPortletPreferencesIds

public static PortletPreferencesIds getPortletPreferencesIds(long companyId,
                                                             long siteGroupId,
                                                             long plid,
                                                             String portletId,
                                                             String settingsScope)

getPortletSetup

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

getPortletSetup

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

getPortletSetup

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

getPortletSetup

public static PortletPreferences getPortletSetup(long siteGroupId,
                                                 Layout layout,
                                                 String portletId,
                                                 String defaultPreferences)

getPortletSetup

public static PortletPreferences getPortletSetup(PortletRequest portletRequest)
                                          throws PortalException
Throws:
PortalException

getPortletSetup

public static PortletPreferences getPortletSetup(PortletRequest portletRequest,
                                                 String portletId)
                                          throws PortalException
Throws:
PortalException

getPortletSetupMap

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

getPreferences

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

getPreferencesValidator

public static PreferencesValidator getPreferencesValidator(Portlet portlet)

getStrictLayoutPortletSetup

public static PortletPreferences getStrictLayoutPortletSetup(Layout layout,
                                                             String portletId)

getStrictPortletSetup

public static PortletPreferences getStrictPortletSetup(Layout layout,
                                                       String portletId)

getStrictPortletSetup

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

strictFromXML

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

toXML

public static String toXML(PortalPreferences portalPreferences)

toXML

public static String toXML(PortletPreferences portletPreferences)

setPortletPreferencesFactory

public void setPortletPreferencesFactory(PortletPreferencesFactory portletPreferencesFactory)

Liferay 7.0-ce-b4