01: /**
02: * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
03: *
04: * Permission is hereby granted, free of charge, to any person obtaining a copy
05: * of this software and associated documentation files (the "Software"), to deal
06: * in the Software without restriction, including without limitation the rights
07: * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
08: * copies of the Software, and to permit persons to whom the Software is
09: * 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: */package com.liferay.portlet;
22:
23: import com.liferay.portal.PortalException;
24: import com.liferay.portal.SystemException;
25: import com.liferay.portal.model.Layout;
26: import com.liferay.portal.model.Portlet;
27: import com.liferay.portal.model.PortletPreferencesIds;
28:
29: import javax.portlet.ActionRequest;
30: import javax.portlet.PortletPreferences;
31: import javax.portlet.PreferencesValidator;
32: import javax.portlet.RenderRequest;
33:
34: import javax.servlet.http.HttpServletRequest;
35:
36: /**
37: * <a href="PortletPreferencesFactory.java.html"><b><i>View Source</i></b></a>
38: *
39: * @author Brian Wing Shun Chan
40: *
41: */
42: public interface PortletPreferencesFactory {
43:
44: public PortalPreferences getPortalPreferences(HttpServletRequest req)
45: throws PortalException, SystemException;
46:
47: public PortalPreferences getPortalPreferences(ActionRequest req)
48: throws PortalException, SystemException;
49:
50: public PortalPreferences getPortalPreferences(RenderRequest req)
51: throws PortalException, SystemException;
52:
53: public PortletPreferences getPortletPreferences(
54: HttpServletRequest req, String portletId)
55: throws PortalException, SystemException;
56:
57: public PortletPreferencesIds getPortletPreferencesIds(
58: HttpServletRequest req, String portletId)
59: throws PortalException, SystemException;
60:
61: public PortletPreferencesIds getPortletPreferencesIds(
62: HttpServletRequest req, Layout selLayout, String portletId)
63: throws PortalException, SystemException;
64:
65: public PortletPreferences getPortletSetup(Layout layout,
66: String portletId) throws PortalException, SystemException;
67:
68: public PortletPreferences getPortletSetup(HttpServletRequest req,
69: String portletId, boolean uniquePerLayout,
70: boolean uniquePerGroup) throws PortalException,
71: SystemException;
72:
73: public PortletPreferences getPortletSetup(HttpServletRequest req,
74: String portletId, boolean uniquePerLayout,
75: boolean uniquePerGroup, String defaultPreferences)
76: throws PortalException, SystemException;
77:
78: public PortletPreferences getPortletSetup(Layout layout,
79: String portletId, boolean uniquePerLayout,
80: boolean uniquePerGroup, String defaultPreferences)
81: throws PortalException, SystemException;
82:
83: public PortletPreferences getPortletSetup(ActionRequest req,
84: String portletId, boolean uniquePerLayout,
85: boolean uniquePerGroup) throws PortalException,
86: SystemException;
87:
88: public PortletPreferences getPortletSetup(RenderRequest req,
89: String portletId, boolean uniquePerLayout,
90: boolean uniquePerGroup) throws PortalException,
91: SystemException;
92:
93: public PortletPreferences getPreferences(HttpServletRequest req);
94:
95: public PreferencesValidator getPreferencesValidator(Portlet portlet);
96:
97: }
|