1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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.PortletPreferences;
32  import javax.portlet.PortletRequest;
33  import javax.portlet.PreferencesValidator;
34  
35  import javax.servlet.http.HttpServletRequest;
36  
37  /**
38   * <a href="PortletPreferencesFactory.java.html"><b><i>View Source</i></b></a>
39   *
40   * @author Brian Wing Shun Chan
41   */
42  public interface PortletPreferencesFactory {
43  
44      public PortletPreferences getLayoutPortletSetup(
45              Layout layout, String portletId)
46          throws SystemException;
47  
48      public PortalPreferences getPortalPreferences(HttpServletRequest request)
49          throws SystemException;
50  
51      public PortalPreferences getPortalPreferences(PortletRequest portletRequest)
52          throws SystemException;
53  
54      public PortletPreferences getPortletPreferences(
55              HttpServletRequest request, String portletId)
56          throws PortalException, SystemException;
57  
58      public PortletPreferencesIds getPortletPreferencesIds(
59              HttpServletRequest request, String portletId)
60          throws PortalException, SystemException;
61  
62      public PortletPreferencesIds getPortletPreferencesIds(
63              HttpServletRequest request, Layout selLayout, String portletId)
64          throws PortalException, SystemException;
65  
66      public PortletPreferences getPortletSetup(
67              Layout layout, String portletId, String defaultPreferences)
68          throws SystemException;
69  
70      public PortletPreferences getPortletSetup(
71              HttpServletRequest request, String portletId)
72          throws SystemException;
73  
74      public PortletPreferences getPortletSetup(
75              HttpServletRequest request, String portletId,
76              String defaultPreferences)
77          throws SystemException;
78  
79      public PortletPreferences getPortletSetup(PortletRequest portletRequest)
80          throws SystemException;
81  
82      public PortletPreferences getPortletSetup(
83              PortletRequest portletRequest, String portletId)
84          throws SystemException;
85  
86      public PortletPreferences getPreferences(HttpServletRequest request);
87  
88      public PreferencesValidator getPreferencesValidator(Portlet portlet);
89  
90  }