| PortletBag.java |
1 /**
2 * Copyright (c) 2000-2009 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.portal.kernel.portlet;
24
25 import com.liferay.portal.kernel.job.Scheduler;
26 import com.liferay.portal.kernel.pop.MessageListener;
27 import com.liferay.portal.kernel.search.Indexer;
28 import com.liferay.portal.kernel.search.OpenSearch;
29 import com.liferay.portal.kernel.servlet.URLEncoder;
30
31 import java.util.Locale;
32 import java.util.ResourceBundle;
33
34 import javax.portlet.Portlet;
35 import javax.portlet.PreferencesValidator;
36
37 import javax.servlet.ServletContext;
38
39 /**
40 * <a href="PortletBag.java.html"><b><i>View Source</i></b></a>
41 *
42 * @author Brian Wing Shun Chan
43 *
44 */
45 public interface PortletBag {
46
47 public String getPortletName();
48
49 public ServletContext getServletContext();
50
51 public Portlet getPortletInstance();
52
53 public void removePortletInstance();
54
55 public ConfigurationAction getConfigurationActionInstance();
56
57 public Indexer getIndexerInstance();
58
59 public OpenSearch getOpenSearchInstance();
60
61 public Scheduler getSchedulerInstance();
62
63 public FriendlyURLMapper getFriendlyURLMapperInstance();
64
65 public URLEncoder getURLEncoderInstance();
66
67 public PortletLayoutListener getPortletLayoutListenerInstance();
68
69 public MessageListener getPopMessageListenerInstance();
70
71 public PreferencesValidator getPreferencesValidatorInstance();
72
73 public ResourceBundle getResourceBundle(Locale locale);
74
75 }