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