Liferay 7.0-ce-b4

com.liferay.portlet
Class PortletPreferencesFactoryImpl

java.lang.Object
  extended by 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)
           
static Map<String,Preference> createPreferencesMap(String xml)
           
 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 getExistingPortletSetup(Layout layout, String portletId)
           
 PortletPreferences getExistingPortletSetup(PortletRequest portletRequest)
           
 PortletPreferences getLayoutPortletSetup(Layout layout, String portletId)
           
 PortletPreferences getLayoutPortletSetup(Layout layout, String portletId, String defaultPreferences)
           
 PortletPreferences getLayoutPortletSetup(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences)
           
 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 siteGroupId, long userId, Layout layout, String portletId, boolean modeEditGuest)
           
 PortletPreferencesIds getPortletPreferencesIds(long companyId, long siteGroupId, long plid, String portletId, String settingsScope)
           
 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 siteGroupId, Layout layout, String portletId, String defaultPreferences)
           
protected  PortletPreferences getPortletSetup(long companyId, long siteGroupId, long layoutGroupId, long plid, 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)
           
 PortletPreferences getStrictPortletSetup(long companyId, long groupId, String portletId)
           
protected static 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

createPreferencesMap

public static Map<String,Preference> createPreferencesMap(String xml)

checkControlPanelPortletPreferences

public void checkControlPanelPortletPreferences(ThemeDisplay themeDisplay,
                                                Portlet portlet)
                                         throws PortalException
Specified by:
checkControlPanelPortletPreferences in interface PortletPreferencesFactory
Throws:
PortalException

fromDefaultXML

public PortletPreferences fromDefaultXML(String xml)
Specified by:
fromDefaultXML in interface PortletPreferencesFactory

fromXML

public PortalPreferencesImpl fromXML(long ownerId,
                                     int ownerType,
                                     String xml)
Specified by:
fromXML in interface PortletPreferencesFactory

fromXML

public PortletPreferencesImpl fromXML(long companyId,
                                      long ownerId,
                                      int ownerType,
                                      long plid,
                                      String portletId,
                                      String xml)
Specified by:
fromXML in interface PortletPreferencesFactory

fromXML

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

Specified by:
fromXML in interface PortletPreferencesFactory

getExistingPortletSetup

public PortletPreferences getExistingPortletSetup(Layout layout,
                                                  String portletId)
                                           throws PortalException
Specified by:
getExistingPortletSetup in interface PortletPreferencesFactory
Throws:
PortalException

getExistingPortletSetup

public PortletPreferences getExistingPortletSetup(PortletRequest portletRequest)
                                           throws PortalException
Specified by:
getExistingPortletSetup in interface PortletPreferencesFactory
Throws:
PortalException

getLayoutPortletSetup

public PortletPreferences getLayoutPortletSetup(Layout layout,
                                                String portletId)
Specified by:
getLayoutPortletSetup in interface PortletPreferencesFactory

getLayoutPortletSetup

public PortletPreferences getLayoutPortletSetup(Layout layout,
                                                String portletId,
                                                String defaultPreferences)
Specified by:
getLayoutPortletSetup in interface PortletPreferencesFactory

getLayoutPortletSetup

public PortletPreferences getLayoutPortletSetup(long companyId,
                                                long ownerId,
                                                int ownerType,
                                                long plid,
                                                String portletId,
                                                String defaultPreferences)
Specified by:
getLayoutPortletSetup in interface PortletPreferencesFactory

getPortalPreferences

public PortalPreferences getPortalPreferences(javax.servlet.http.HttpServletRequest request)
Specified by:
getPortalPreferences in interface PortletPreferencesFactory

getPortalPreferences

public PortalPreferences getPortalPreferences(javax.servlet.http.HttpSession session,
                                              long userId,
                                              boolean signedIn)
Specified by:
getPortalPreferences in interface PortletPreferencesFactory

getPortalPreferences

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

Specified by:
getPortalPreferences in interface PortletPreferencesFactory

getPortalPreferences

public PortalPreferences getPortalPreferences(long userId,
                                              boolean signedIn)
Specified by:
getPortalPreferences in interface PortletPreferencesFactory

getPortalPreferences

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

Specified by:
getPortalPreferences in interface PortletPreferencesFactory

getPortalPreferences

public PortalPreferences getPortalPreferences(PortletRequest portletRequest)
Specified by:
getPortalPreferences in interface PortletPreferencesFactory

getPortletPreferences

public PortletPreferences getPortletPreferences(javax.servlet.http.HttpServletRequest request,
                                                String portletId)
                                         throws PortalException
Specified by:
getPortletPreferences in interface PortletPreferencesFactory
Throws:
PortalException

getPortletPreferencesIds

public PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request,
                                                      Layout layout,
                                                      String portletId)
                                               throws PortalException
Specified by:
getPortletPreferencesIds in interface PortletPreferencesFactory
Throws:
PortalException

getPortletPreferencesIds

public PortletPreferencesIds getPortletPreferencesIds(javax.servlet.http.HttpServletRequest request,
                                                      String portletId)
                                               throws PortalException
Specified by:
getPortletPreferencesIds in interface PortletPreferencesFactory
Throws:
PortalException

getPortletPreferencesIds

public PortletPreferencesIds getPortletPreferencesIds(long siteGroupId,
                                                      long userId,
                                                      Layout layout,
                                                      String portletId,
                                                      boolean modeEditGuest)
                                               throws PortalException
Specified by:
getPortletPreferencesIds in interface PortletPreferencesFactory
Throws:
PortalException

getPortletPreferencesIds

public PortletPreferencesIds getPortletPreferencesIds(long companyId,
                                                      long siteGroupId,
                                                      long plid,
                                                      String portletId,
                                                      String settingsScope)
Specified by:
getPortletPreferencesIds in interface PortletPreferencesFactory

getPortletSetup

public PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request,
                                          String portletId)
Specified by:
getPortletSetup in interface PortletPreferencesFactory

getPortletSetup

public PortletPreferences getPortletSetup(javax.servlet.http.HttpServletRequest request,
                                          String portletId,
                                          String defaultPreferences)
Specified by:
getPortletSetup in interface PortletPreferencesFactory

getPortletSetup

public PortletPreferences getPortletSetup(Layout layout,
                                          String portletId,
                                          String defaultPreferences)
Specified by:
getPortletSetup in interface PortletPreferencesFactory

getPortletSetup

public PortletPreferences getPortletSetup(long siteGroupId,
                                          Layout layout,
                                          String portletId,
                                          String defaultPreferences)
Specified by:
getPortletSetup in interface PortletPreferencesFactory

getPortletSetup

public PortletPreferences getPortletSetup(PortletRequest portletRequest)
Specified by:
getPortletSetup in interface PortletPreferencesFactory

getPortletSetup

public PortletPreferences getPortletSetup(PortletRequest portletRequest,
                                          String portletId)
Specified by:
getPortletSetup in interface PortletPreferencesFactory

getPortletSetupMap

public Map<Long,PortletPreferences> getPortletSetupMap(long companyId,
                                                       long groupId,
                                                       long ownerId,
                                                       int ownerType,
                                                       String portletId,
                                                       boolean privateLayout)
Specified by:
getPortletSetupMap in interface PortletPreferencesFactory

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)
Specified by:
getStrictLayoutPortletSetup in interface PortletPreferencesFactory

getStrictPortletSetup

public PortletPreferences getStrictPortletSetup(Layout layout,
                                                String portletId)
Specified by:
getStrictPortletSetup in interface PortletPreferencesFactory

getStrictPortletSetup

public PortletPreferences getStrictPortletSetup(long companyId,
                                                long groupId,
                                                String portletId)
Specified by:
getStrictPortletSetup in interface PortletPreferencesFactory

strictFromXML

public StrictPortletPreferencesImpl strictFromXML(long companyId,
                                                  long ownerId,
                                                  int ownerType,
                                                  long plid,
                                                  String portletId,
                                                  String xml)
Specified by:
strictFromXML in interface PortletPreferencesFactory

toXML

public String toXML(PortalPreferences portalPreferences)
Specified by:
toXML in interface PortletPreferencesFactory

toXML

public String toXML(PortletPreferences portletPreferences)
Specified by:
toXML in interface PortletPreferencesFactory

readPreference

protected static Preference readPreference(XMLEventReader xmlEventReader)
                                    throws XMLStreamException
Throws:
XMLStreamException

getPortletSetup

protected PortletPreferences getPortletSetup(long companyId,
                                             long siteGroupId,
                                             long layoutGroupId,
                                             long plid,
                                             String portletId,
                                             String defaultPreferences,
                                             boolean strictMode)

toPreferencesMap

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

Liferay 7.0-ce-b4