com.liferay.portlet
Interface PortletPreferencesFactory


public interface PortletPreferencesFactory

Author:
Brian Wing Shun Chan

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

Method Detail

fromDefaultXML

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

fromXML

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

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

getLayoutPortletSetup

javax.portlet.PortletPreferences getLayoutPortletSetup(Layout layout,
                                                       java.lang.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 companyId,
                                       long userId,
                                       boolean signedIn)
                                       throws SystemException
Throws:
SystemException

getPortalPreferences

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

getPortalPreferences

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

getPortletPreferences

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

getPortletPreferencesIds

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

getPortletPreferencesIds

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

getPortletPreferencesIds

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

getPortletSetup

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

getPortletSetup

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

getPortletSetup

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

getPortletSetup

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

getPortletSetup

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

getPortletSetup

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

getPortletSetupMap

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

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

getPreferencesValidator

javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)

getStrictLayoutPortletSetup

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

toXML

java.lang.String toXML(PortalPreferences portalPreferences)

toXML

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