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