com.liferay.portlet
Class PortletPreferencesFactoryImpl

java.lang.Object
  com.liferay.portlet.PortletPreferencesFactoryImpl

All Implemented Interfaces:

PortletPreferencesFactory

public class PortletPreferencesFactoryImpl
extends Object
implements PortletPreferencesFactory

Constructor Summary

PortletPreferencesFactoryImpl()

Method Summary

void	checkControlPanelPortletPreferences(ThemeDisplay themeDisplay, Portlet portlet)
PortletPreferences	fromDefaultXML(String xml)
PortalPreferencesImpl	fromXML(long ownerId, int ownerType, String xml)
PortletPreferencesImpl	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	getLayoutPortletSetup(Layout layout, String portletId)
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 layout, String portletId)
PortletPreferencesIds	getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, String portletId)
PortletPreferencesIds	getPortletPreferencesIds(long scopeGroupId, long userId, Layout layout, String portletId, boolean modeEditGuest)
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)
protected PortletPreferences	getPortletSetup(long scopeGroupId, Layout layout, String portletId, String defaultPreferences, boolean strictMode)
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)
protected Preference	readPreference(XMLEventReader xmlEventReader)
StrictPortletPreferencesImpl	strictFromXML(long companyId, long ownerId, int ownerType, long plid, String portletId, String xml)
protected Map<String,Preference>	toPreferencesMap(String xml)
String	toXML(PortalPreferences portalPreferences)
String	toXML(PortletPreferences portletPreferences)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletPreferencesFactoryImpl

public PortletPreferencesFactoryImpl()

Method Detail

checkControlPanelPortletPreferences

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

Specified by:

checkControlPanelPortletPreferences in interface PortletPreferencesFactory

Throws:

PortalException

SystemException

fromDefaultXML

public PortletPreferences fromDefaultXML(String xml)
                                  throws SystemException

Specified by:

fromDefaultXML in interface PortletPreferencesFactory

Throws:

SystemException

fromXML

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

Specified by:

fromXML in interface PortletPreferencesFactory

Throws:

SystemException

fromXML

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

Specified by:

fromXML in interface PortletPreferencesFactory

Throws:

SystemException

fromXML

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

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

Specified by:

fromXML in interface PortletPreferencesFactory

Throws:

SystemException

getLayoutPortletSetup

public PortletPreferences getLayoutPortletSetup(Layout layout,
                                                String portletId)
                                         throws SystemException

Specified by:

getLayoutPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

getPortalPreferences

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

Specified by:

getPortalPreferences in interface PortletPreferencesFactory

Throws:

SystemException

getPortalPreferences

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

Specified by:

getPortalPreferences in interface PortletPreferencesFactory

Throws:

SystemException

getPortalPreferences

public 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)

Specified by:

getPortalPreferences in interface PortletPreferencesFactory

Throws:

SystemException

getPortalPreferences

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

Specified by:

getPortalPreferences in interface PortletPreferencesFactory

Throws:

SystemException

getPortalPreferences

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

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

Specified by:

getPortalPreferences in interface PortletPreferencesFactory

Throws:

SystemException

getPortalPreferences

public PortalPreferences getPortalPreferences(PortletRequest portletRequest)
                                       throws SystemException

Specified by:

getPortalPreferences in interface PortletPreferencesFactory

Throws:

SystemException

getPortletPreferences

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

Specified by:

getPortletPreferences in interface PortletPreferencesFactory

Throws:

PortalException

SystemException

getPortletPreferencesIds

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

Specified by:

getPortletPreferencesIds in interface PortletPreferencesFactory

Throws:

PortalException

SystemException

getPortletPreferencesIds

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

Specified by:

getPortletPreferencesIds in interface PortletPreferencesFactory

Throws:

PortalException

SystemException

getPortletPreferencesIds

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

Specified by:

getPortletPreferencesIds in interface PortletPreferencesFactory

Throws:

PortalException

SystemException

getPortletSetup

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

Specified by:

getPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

getPortletSetup

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

Specified by:

getPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

getPortletSetup

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

Specified by:

getPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

getPortletSetup

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

Specified by:

getPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

getPortletSetup

public PortletPreferences getPortletSetup(PortletRequest portletRequest)
                                   throws SystemException

Specified by:

getPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

getPortletSetup

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

Specified by:

getPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

getPortletSetupMap

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

Specified by:

getPortletSetupMap in interface PortletPreferencesFactory

Throws:

SystemException

getPreferences

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

Specified by:

getPreferences in interface PortletPreferencesFactory

getPreferencesValidator

public PreferencesValidator getPreferencesValidator(Portlet portlet)

Specified by:

getPreferencesValidator in interface PortletPreferencesFactory

getStrictLayoutPortletSetup

public PortletPreferences getStrictLayoutPortletSetup(Layout layout,
                                                      String portletId)
                                               throws SystemException

Specified by:

getStrictLayoutPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

getStrictPortletSetup

public PortletPreferences getStrictPortletSetup(Layout layout,
                                                String portletId)
                                         throws SystemException

Specified by:

getStrictPortletSetup in interface PortletPreferencesFactory

Throws:

SystemException

strictFromXML

public StrictPortletPreferencesImpl strictFromXML(long companyId,
                                                  long ownerId,
                                                  int ownerType,
                                                  long plid,
                                                  String portletId,
                                                  String xml)
                                           throws SystemException

Specified by:

strictFromXML in interface PortletPreferencesFactory

Throws:

SystemException

toXML

public String toXML(PortalPreferences portalPreferences)

Specified by:

toXML in interface PortletPreferencesFactory

toXML

public String toXML(PortletPreferences portletPreferences)

Specified by:

toXML in interface PortletPreferencesFactory

getPortletSetup

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

Throws:

SystemException

readPreference

protected Preference readPreference(XMLEventReader xmlEventReader)
                             throws XMLStreamException

Throws:

XMLStreamException

toPreferencesMap

protected Map<String,Preference> toPreferencesMap(String xml)
                                           throws SystemException

Throws:

SystemException