com.liferay.portlet
Class PortletPreferencesFactoryImpl

java.lang.Object
  extended by com.liferay.portlet.PortletPreferencesFactoryImpl
All Implemented Interfaces:
com.liferay.portlet.PortletPreferencesFactory

public class PortletPreferencesFactoryImpl
extends java.lang.Object
implements com.liferay.portlet.PortletPreferencesFactory

Author:
Brian Wing Shun Chan, Alexander Chow, Minhchau Dang

Constructor Summary
PortletPreferencesFactoryImpl()
           
 
Method Summary
 javax.portlet.PortletPreferences fromDefaultXML(java.lang.String xml)
           
 PortletPreferencesImpl fromXML(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId, java.lang.String xml)
           
 PortalPreferencesImpl fromXML(long companyId, long ownerId, int ownerType, java.lang.String xml)
           
 javax.portlet.PortletPreferences getLayoutPortletSetup(com.liferay.portal.model.Layout layout, java.lang.String portletId)
           
 com.liferay.portlet.PortalPreferences getPortalPreferences(javax.servlet.http.HttpServletRequest request)
           
 com.liferay.portlet.PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession session, long companyId, long userId, boolean signedIn)
           
 com.liferay.portlet.PortalPreferences getPortalPreferences(long companyId, long userId, boolean signedIn)
           
 com.liferay.portlet.PortalPreferences getPortalPreferences(javax.portlet.PortletRequest portletRequest)
           
 javax.portlet.PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest request, java.lang.String portletId)
           
 com.liferay.portal.model.PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, com.liferay.portal.model.Layout layout, java.lang.String portletId)
           
 com.liferay.portal.model.PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request, java.lang.String portletId)
           
 com.liferay.portal.model.PortletPreferencesIds getPortletPreferencesIds(long scopeGroupId, long userId, com.liferay.portal.model.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(com.liferay.portal.model.Layout layout, java.lang.String portletId, java.lang.String defaultPreferences)
           
 javax.portlet.PortletPreferences getPortletSetup(long scopeGroupId, com.liferay.portal.model.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(com.liferay.portal.model.Portlet portlet)
           
 javax.portlet.PortletPreferences getStrictLayoutPortletSetup(com.liferay.portal.model.Layout layout, java.lang.String portletId)
           
protected  void populateMap(java.lang.String xml, java.util.Map<java.lang.String,Preference> preferencesMap)
           
protected  Preference readPreference(javax.xml.stream.XMLEventReader xmlEventReader)
           
protected  java.lang.String toXML(java.util.Map<java.lang.String,Preference> preferencesMap)
           
 java.lang.String toXML(com.liferay.portlet.PortalPreferences portalPreferences)
           
 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

PortletPreferencesFactoryImpl

public PortletPreferencesFactoryImpl()
Method Detail

fromDefaultXML

public javax.portlet.PortletPreferences fromDefaultXML(java.lang.String xml)
                                                throws com.liferay.portal.kernel.exception.SystemException
Specified by:
fromDefaultXML in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

fromXML

public PortletPreferencesImpl fromXML(long companyId,
                                      long ownerId,
                                      int ownerType,
                                      long plid,
                                      java.lang.String portletId,
                                      java.lang.String xml)
                               throws com.liferay.portal.kernel.exception.SystemException
Specified by:
fromXML in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

fromXML

public PortalPreferencesImpl fromXML(long companyId,
                                     long ownerId,
                                     int ownerType,
                                     java.lang.String xml)
                              throws com.liferay.portal.kernel.exception.SystemException
Specified by:
fromXML in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getLayoutPortletSetup

public javax.portlet.PortletPreferences getLayoutPortletSetup(com.liferay.portal.model.Layout layout,
                                                              java.lang.String portletId)
                                                       throws com.liferay.portal.kernel.exception.SystemException
Specified by:
getLayoutPortletSetup in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getPortalPreferences

public com.liferay.portlet.PortalPreferences getPortalPreferences(javax.servlet.http.HttpServletRequest request)
                                                           throws com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortalPreferences in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getPortalPreferences

public com.liferay.portlet.PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession session,
                                                                  long companyId,
                                                                  long userId,
                                                                  boolean signedIn)
                                                           throws com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortalPreferences in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getPortalPreferences

public com.liferay.portlet.PortalPreferences getPortalPreferences(long companyId,
                                                                  long userId,
                                                                  boolean signedIn)
                                                           throws com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortalPreferences in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getPortalPreferences

public com.liferay.portlet.PortalPreferences getPortalPreferences(javax.portlet.PortletRequest portletRequest)
                                                           throws com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortalPreferences in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getPortletPreferences

public javax.portlet.PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest request,
                                                              java.lang.String portletId)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletPreferences in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

getPortletPreferencesIds

public com.liferay.portal.model.PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request,
                                                                               com.liferay.portal.model.Layout layout,
                                                                               java.lang.String portletId)
                                                                        throws com.liferay.portal.kernel.exception.PortalException,
                                                                               com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletPreferencesIds in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

getPortletPreferencesIds

public com.liferay.portal.model.PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request,
                                                                               java.lang.String portletId)
                                                                        throws com.liferay.portal.kernel.exception.PortalException,
                                                                               com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletPreferencesIds in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

getPortletPreferencesIds

public com.liferay.portal.model.PortletPreferencesIds getPortletPreferencesIds(long scopeGroupId,
                                                                               long userId,
                                                                               com.liferay.portal.model.Layout layout,
                                                                               java.lang.String portletId,
                                                                               boolean modeEditGuest)
                                                                        throws com.liferay.portal.kernel.exception.PortalException,
                                                                               com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletPreferencesIds in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request,
                                                        java.lang.String portletId)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletSetup in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request,
                                                        java.lang.String portletId,
                                                        java.lang.String defaultPreferences)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletSetup in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(com.liferay.portal.model.Layout layout,
                                                        java.lang.String portletId,
                                                        java.lang.String defaultPreferences)
                                                 throws com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletSetup in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(long scopeGroupId,
                                                        com.liferay.portal.model.Layout layout,
                                                        java.lang.String portletId,
                                                        java.lang.String defaultPreferences)
                                                 throws com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletSetup in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(javax.portlet.PortletRequest portletRequest)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletSetup in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

getPortletSetup

public javax.portlet.PortletPreferences getPortletSetup(javax.portlet.PortletRequest portletRequest,
                                                        java.lang.String portletId)
                                                 throws com.liferay.portal.kernel.exception.PortalException,
                                                        com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletSetup in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

getPortletSetupMap

public 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 com.liferay.portal.kernel.exception.SystemException
Specified by:
getPortletSetupMap in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

getPreferences

public javax.portlet.PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)
Specified by:
getPreferences in interface com.liferay.portlet.PortletPreferencesFactory

getPreferencesValidator

public javax.portlet.PreferencesValidator getPreferencesValidator(com.liferay.portal.model.Portlet portlet)
Specified by:
getPreferencesValidator in interface com.liferay.portlet.PortletPreferencesFactory

getStrictLayoutPortletSetup

public javax.portlet.PortletPreferences getStrictLayoutPortletSetup(com.liferay.portal.model.Layout layout,
                                                                    java.lang.String portletId)
                                                             throws com.liferay.portal.kernel.exception.SystemException
Specified by:
getStrictLayoutPortletSetup in interface com.liferay.portlet.PortletPreferencesFactory
Throws:
com.liferay.portal.kernel.exception.SystemException

toXML

public java.lang.String toXML(com.liferay.portlet.PortalPreferences portalPreferences)
Specified by:
toXML in interface com.liferay.portlet.PortletPreferencesFactory

toXML

public java.lang.String toXML(javax.portlet.PortletPreferences portletPreferences)
Specified by:
toXML in interface com.liferay.portlet.PortletPreferencesFactory

populateMap

protected void populateMap(java.lang.String xml,
                           java.util.Map<java.lang.String,Preference> preferencesMap)
                    throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

readPreference

protected Preference readPreference(javax.xml.stream.XMLEventReader xmlEventReader)
                             throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

toXML

protected java.lang.String toXML(java.util.Map<java.lang.String,Preference> preferencesMap)