| PortletBag.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * The contents of this file are subject to the terms of the Liferay Enterprise
5 * Subscription License ("License"). You may not use this file except in
6 * compliance with the License. You can obtain a copy of the License by
7 * contacting Liferay, Inc. See the License for the specific language governing
8 * permissions and limitations under the License, including but not limited to
9 * distribution rights of the Software.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17 * SOFTWARE.
18 */
19
20 package com.liferay.portal.kernel.portlet;
21
22 import com.liferay.portal.kernel.job.Scheduler;
23 import com.liferay.portal.kernel.pop.MessageListener;
24 import com.liferay.portal.kernel.search.Indexer;
25 import com.liferay.portal.kernel.search.OpenSearch;
26 import com.liferay.portal.kernel.servlet.URLEncoder;
27
28 import java.util.Locale;
29 import java.util.ResourceBundle;
30
31 import javax.portlet.Portlet;
32 import javax.portlet.PreferencesValidator;
33
34 import javax.servlet.ServletContext;
35
36 /**
37 * <a href="PortletBag.java.html"><b><i>View Source</i></b></a>
38 *
39 * @author Brian Wing Shun Chan
40 *
41 */
42 public interface PortletBag {
43
44 public String getPortletName();
45
46 public ServletContext getServletContext();
47
48 public Portlet getPortletInstance();
49
50 public void removePortletInstance();
51
52 public ConfigurationAction getConfigurationActionInstance();
53
54 public Indexer getIndexerInstance();
55
56 public OpenSearch getOpenSearchInstance();
57
58 public Scheduler getSchedulerInstance();
59
60 public FriendlyURLMapper getFriendlyURLMapperInstance();
61
62 public URLEncoder getURLEncoderInstance();
63
64 public PortletLayoutListener getPortletLayoutListenerInstance();
65
66 public MessageListener getPopMessageListenerInstance();
67
68 public PreferencesValidator getPreferencesValidatorInstance();
69
70 public ResourceBundle getResourceBundle(Locale locale);
71
72 }