com.liferay.portlet
Class PortletPreferencesFactoryUtil

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

public class PortletPreferencesFactoryUtil
extends java.lang.Object

Author:
Brian Wing Shun Chan

Constructor Summary
PortletPreferencesFactoryUtil()
           
 
Method Summary
static javax.portlet.PortletPreferences fromDefaultXML(java.lang.String xml)
           
static javax.portlet.PortletPreferences fromXML(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId, java.lang.String xml)
           
static PortalPreferences fromXML(long companyId, long ownerId, int ownerType, java.lang.String xml)
           
static javax.portlet.PortletPreferences getLayoutPortletSetup(Layout layout, java.lang.String portletId)
           
static PortalPreferences getPortalPreferences(javax.servlet.http.HttpServletRequest request)
           
static PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession session, long companyId, long userId, boolean signedIn)
           
static PortalPreferences getPortalPreferences(long companyId, long userId, boolean signedIn)
           
static PortalPreferences getPortalPreferences(javax.portlet.PortletRequest portletRequest)
           
static javax.portlet.PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest request, java.lang.String portletId)
           
static PortletPreferencesFactory getPortletPreferencesFactory()
           
static PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, Layout selLayout, java.lang.String portletId)
           
static PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, java.lang.String portletId)
           
static PortletPreferencesIds getPortletPreferencesIds(long scopeGroupId, long userId, Layout layout, java.lang.String portletId, boolean modeEditGuest)
           
static javax.portlet.PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request, java.lang.String portletId)
           
static javax.portlet.PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request, java.lang.String portletId, java.lang.String defaultPreferences)
           
static javax.portlet.PortletPreferences getPortletSetup(Layout layout, java.lang.String portletId, java.lang.String defaultPreferences)
           
static javax.portlet.PortletPreferences getPortletSetup(long scopeGroupId, Layout layout, java.lang.String portletId, java.lang.String defaultPreferences)
           
static javax.portlet.PortletPreferences getPortletSetup(javax.portlet.PortletRequest portletRequest)
           
static javax.portlet.PortletPreferences getPortletSetup(javax.portlet.PortletRequest portletRequest, java.lang.String portletId)
           
static java.util.Map<java.lang.Long,javax.portlet.PortletPreferences> getPortletSetupMap(long companyId, long groupId, long ownerId, int ownerType, java.lang.String portletId, boolean privateLayout)
           
static javax.portlet.PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)
           
static javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)
           
static javax.portlet.PortletPreferences getStrictLayoutPortletSetup(Layout layout, java.lang.String portletId)
           
 void setPortletPreferencesFactory(PortletPreferencesFactory portletPreferencesFactory)
           
static java.lang.String toXML(PortalPreferences portalPreferences)
           
static java.lang.String toXML(javax.portlet.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

fromDefaultXML

public static javax.portlet.PortletPreferences fromDefaultXML(java.lang.String xml)
                                                       throws SystemException
Throws:
SystemException

fromXML

public static javax.portlet.PortletPreferences fromXML(long companyId,
                                                       long ownerId,
                                                       int ownerType,
                                                       long plid,
                                                       java.lang.String portletId,
                                                       java.lang.String xml)
                                                throws SystemException
Throws:
SystemException

fromXML

public static PortalPreferences fromXML(long companyId,
                                        long ownerId,
                                        int ownerType,
                                        java.lang.String xml)
                                 throws SystemException
Throws:
SystemException

getLayoutPortletSetup

public static javax.portlet.PortletPreferences getLayoutPortletSetup(Layout layout,
                                                                     java.lang.String portletId)
                                                              throws SystemException
Throws:
SystemException

getPortalPreferences

public static PortalPreferences getPortalPreferences(javax.servlet.http.HttpServletRequest request)
                                              throws SystemException
Throws:
SystemException

getPortalPreferences

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

getPortalPreferences

public static PortalPreferences getPortalPreferences(long companyId,
                                                     long userId,
                                                     boolean signedIn)
                                              throws SystemException
Throws:
SystemException

getPortalPreferences

public static PortalPreferences getPortalPreferences(javax.portlet.PortletRequest portletRequest)
                                              throws SystemException
Throws:
SystemException

getPortletPreferences

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

getPortletPreferencesFactory

public static PortletPreferencesFactory getPortletPreferencesFactory()

getPortletPreferencesIds

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

getPortletPreferencesIds

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

getPortletPreferencesIds

public static PortletPreferencesIds getPortletPreferencesIds(long scopeGroupId,
                                                             long userId,
                                                             Layout layout,
                                                             java.lang.String portletId,
                                                             boolean modeEditGuest)
                                                      throws PortalException,
                                                             SystemException
Throws:
PortalException
SystemException

getPortletSetup

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

getPortletSetup

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

getPortletSetup

public static javax.portlet.PortletPreferences getPortletSetup(Layout layout,
                                                               java.lang.String portletId,
                                                               java.lang.String defaultPreferences)
                                                        throws SystemException
Throws:
SystemException

getPortletSetup

public static javax.portlet.PortletPreferences getPortletSetup(long scopeGroupId,
                                                               Layout layout,
                                                               java.lang.String portletId,
                                                               java.lang.String defaultPreferences)
                                                        throws SystemException
Throws:
SystemException

getPortletSetup

public static javax.portlet.PortletPreferences getPortletSetup(javax.portlet.PortletRequest portletRequest)
                                                        throws PortalException,
                                                               SystemException
Throws:
PortalException
SystemException

getPortletSetup

public static javax.portlet.PortletPreferences getPortletSetup(javax.portlet.PortletRequest portletRequest,
                                                               java.lang.String portletId)
                                                        throws PortalException,
                                                               SystemException
Throws:
PortalException
SystemException

getPortletSetupMap

public static java.util.Map<java.lang.Long,javax.portlet.PortletPreferences> getPortletSetupMap(long companyId,
                                                                                                long groupId,
                                                                                                long ownerId,
                                                                                                int ownerType,
                                                                                                java.lang.String portletId,
                                                                                                boolean privateLayout)
                                                                                         throws SystemException
Throws:
SystemException

getPreferences

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

getPreferencesValidator

public static javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)

getStrictLayoutPortletSetup

public static javax.portlet.PortletPreferences getStrictLayoutPortletSetup(Layout layout,
                                                                           java.lang.String portletId)
                                                                    throws SystemException
Throws:
SystemException

toXML

public static java.lang.String toXML(PortalPreferences portalPreferences)

toXML

public static java.lang.String toXML(javax.portlet.PortletPreferences portletPreferences)

setPortletPreferencesFactory

public void setPortletPreferencesFactory(PortletPreferencesFactory portletPreferencesFactory)