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="PortletPreferencesFactoryUtil.java.html"><b><i>View Source</i></b>
40   * </a>
41   *
42   * @author Brian Wing Shun Chan
43   *
44   */
45  public class PortletPreferencesFactoryUtil {
46  
47      public static PortletPreferences getLayoutPortletSetup(
48              Layout layout, String portletId)
49          throws SystemException {
50  
51          return getPortletPreferencesFactory().getLayoutPortletSetup(
52              layout, portletId);
53      }
54  
55      public static PortalPreferences getPortalPreferences(
56              HttpServletRequest request)
57          throws SystemException {
58  
59          return getPortletPreferencesFactory().getPortalPreferences(request);
60      }
61  
62      public static PortalPreferences getPortalPreferences(
63              ActionRequest actionRequest)
64          throws SystemException {
65  
66          return getPortletPreferencesFactory().getPortalPreferences(
67              actionRequest);
68      }
69  
70      public static PortalPreferences getPortalPreferences(
71              RenderRequest renderRequest)
72          throws SystemException {
73  
74          return getPortletPreferencesFactory().getPortalPreferences(
75              renderRequest);
76      }
77  
78      public static PortletPreferences getPortletPreferences(
79              HttpServletRequest request, String portletId)
80          throws PortalException, SystemException {
81  
82          return getPortletPreferencesFactory().getPortletPreferences(
83              request, portletId);
84      }
85  
86      public static PortletPreferencesFactory getPortletPreferencesFactory() {
87          return _portletPreferencesFactory;
88      }
89  
90      public static PortletPreferencesIds getPortletPreferencesIds(
91              HttpServletRequest request, String portletId)
92          throws PortalException, SystemException {
93  
94          return getPortletPreferencesFactory().getPortletPreferencesIds(
95              request, portletId);
96      }
97  
98      public static PortletPreferencesIds getPortletPreferencesIds(
99              HttpServletRequest request, Layout selLayout, String portletId)
100         throws PortalException, SystemException {
101 
102         return getPortletPreferencesFactory().getPortletPreferencesIds(
103             request, selLayout, portletId);
104     }
105 
106     public static PortletPreferences getPortletSetup(
107             Layout layout, String portletId, String defaultPreferences)
108         throws SystemException {
109 
110         return getPortletPreferencesFactory().getPortletSetup(
111             layout, portletId, defaultPreferences);
112     }
113 
114     public static PortletPreferences getPortletSetup(
115             HttpServletRequest request, String portletId)
116         throws SystemException {
117 
118         return getPortletPreferencesFactory().getPortletSetup(
119             request, portletId);
120     }
121 
122     public static PortletPreferences getPortletSetup(
123             HttpServletRequest request, String portletId,
124             String defaultPreferences)
125         throws SystemException {
126 
127         return getPortletPreferencesFactory().getPortletSetup(
128             request, portletId, defaultPreferences);
129     }
130 
131     public static PortletPreferences getPortletSetup(
132             ActionRequest actionRequest)
133         throws SystemException {
134 
135         return getPortletPreferencesFactory().getPortletSetup(actionRequest);
136     }
137 
138     public static PortletPreferences getPortletSetup(
139             ActionRequest actionRequest, String portletId)
140         throws SystemException {
141 
142         return getPortletPreferencesFactory().getPortletSetup(
143             actionRequest, portletId);
144     }
145 
146     public static PortletPreferences getPortletSetup(
147             RenderRequest renderRequest)
148         throws SystemException {
149 
150         return getPortletPreferencesFactory().getPortletSetup(renderRequest);
151     }
152 
153     public static PortletPreferences getPortletSetup(
154             RenderRequest renderRequest, String portletId)
155         throws SystemException {
156 
157         return getPortletPreferencesFactory().getPortletSetup(
158             renderRequest, portletId);
159     }
160 
161     public static PortletPreferences getPreferences(
162         HttpServletRequest request) {
163 
164         return getPortletPreferencesFactory().getPreferences(request);
165     }
166 
167     public static PreferencesValidator getPreferencesValidator(
168         Portlet portlet) {
169 
170         return getPortletPreferencesFactory().getPreferencesValidator(portlet);
171     }
172 
173     public void setPortletPreferencesFactory(
174         PortletPreferencesFactory portletPreferencesFactory) {
175 
176         _portletPreferencesFactory = portletPreferencesFactory;
177     }
178 
179     private static PortletPreferencesFactory _portletPreferencesFactory;
180 
181 }