1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portlet;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.model.Layout;
25  import com.liferay.portal.model.Portlet;
26  import com.liferay.portal.model.PortletPreferencesIds;
27  
28  import javax.portlet.PortletPreferences;
29  import javax.portlet.PortletRequest;
30  import javax.portlet.PreferencesValidator;
31  
32  import javax.servlet.http.HttpServletRequest;
33  
34  /**
35   * <a href="PortletPreferencesFactory.java.html"><b><i>View Source</i></b></a>
36   *
37   * @author Brian Wing Shun Chan
38   *
39   */
40  public interface PortletPreferencesFactory {
41  
42      public PortletPreferences getLayoutPortletSetup(
43              Layout layout, String portletId)
44          throws SystemException;
45  
46      public PortalPreferences getPortalPreferences(HttpServletRequest request)
47          throws SystemException;
48  
49      public PortalPreferences getPortalPreferences(PortletRequest portletRequest)
50          throws SystemException;
51  
52      public PortletPreferences getPortletPreferences(
53              HttpServletRequest request, String portletId)
54          throws PortalException, SystemException;
55  
56      public PortletPreferencesIds getPortletPreferencesIds(
57              HttpServletRequest request, String portletId)
58          throws PortalException, SystemException;
59  
60      public PortletPreferencesIds getPortletPreferencesIds(
61              HttpServletRequest request, Layout selLayout, String portletId)
62          throws PortalException, SystemException;
63  
64      public PortletPreferences getPortletSetup(
65              Layout layout, String portletId, String defaultPreferences)
66          throws SystemException;
67  
68      public PortletPreferences getPortletSetup(
69              HttpServletRequest request, String portletId)
70          throws SystemException;
71  
72      public PortletPreferences getPortletSetup(
73              HttpServletRequest request, String portletId,
74              String defaultPreferences)
75          throws SystemException;
76  
77      public PortletPreferences getPortletSetup(PortletRequest portletRequest)
78          throws SystemException;
79  
80      public PortletPreferences getPortletSetup(
81              PortletRequest portletRequest, String portletId)
82          throws SystemException;
83  
84      public PortletPreferences getPreferences(HttpServletRequest request);
85  
86      public PreferencesValidator getPreferencesValidator(Portlet portlet);
87  
88  }