1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portlet;
24  
25  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.model.Layout;
28  import com.liferay.portal.model.Portlet;
29  import com.liferay.portal.model.PortletPreferencesIds;
30  
31  import javax.portlet.ActionRequest;
32  import javax.portlet.PortletPreferences;
33  import javax.portlet.PreferencesValidator;
34  import javax.portlet.RenderRequest;
35  
36  import javax.servlet.http.HttpServletRequest;
37  
38  /**
39   * <a href="PortletPreferencesFactory.java.html"><b><i>View Source</i></b></a>
40   *
41   * @author Brian Wing Shun Chan
42   *
43   */
44  public interface PortletPreferencesFactory {
45  
46      public PortletPreferences getLayoutPortletSetup(
47              Layout layout, String portletId)
48          throws PortalException, SystemException;
49  
50      public PortalPreferences getPortalPreferences(HttpServletRequest request)
51          throws PortalException, SystemException;
52  
53      public PortalPreferences getPortalPreferences(ActionRequest actionRequest)
54          throws PortalException, SystemException;
55  
56      public PortalPreferences getPortalPreferences(RenderRequest renderRequest)
57          throws PortalException, SystemException;
58  
59      public PortletPreferences getPortletPreferences(
60              HttpServletRequest request, String portletId)
61          throws PortalException, SystemException;
62  
63      public PortletPreferencesIds getPortletPreferencesIds(
64              HttpServletRequest request, String portletId)
65          throws PortalException, SystemException;
66  
67      public PortletPreferencesIds getPortletPreferencesIds(
68              HttpServletRequest request, Layout selLayout, String portletId)
69          throws PortalException, SystemException;
70  
71      public PortletPreferences getPortletSetup(
72              Layout layout, String portletId, String defaultPreferences)
73          throws PortalException, SystemException;
74  
75      public PortletPreferences getPortletSetup(
76              HttpServletRequest request, String portletId)
77          throws PortalException, SystemException;
78  
79      public PortletPreferences getPortletSetup(
80              HttpServletRequest request, String portletId,
81              String defaultPreferences)
82          throws PortalException, SystemException;
83  
84      public PortletPreferences getPortletSetup(ActionRequest actionRequest)
85          throws PortalException, SystemException;
86  
87      public PortletPreferences getPortletSetup(
88              ActionRequest actionRequest, String portletId)
89          throws PortalException, SystemException;
90  
91      public PortletPreferences getPortletSetup(RenderRequest renderRequest)
92          throws PortalException, SystemException;
93  
94      public PortletPreferences getPortletSetup(
95              RenderRequest renderRequest, String portletId)
96          throws PortalException, SystemException;
97  
98      public PortletPreferences getPreferences(HttpServletRequest request);
99  
100     public PreferencesValidator getPreferencesValidator(Portlet portlet);
101 
102 }