1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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.Map;
34  import java.util.ResourceBundle;
35  
36  import javax.portlet.Portlet;
37  import javax.portlet.PreferencesValidator;
38  
39  import javax.servlet.ServletContext;
40  
41  /**
42   * <a href="PortletBag.java.html"><b><i>View Source</i></b></a>
43   *
44   * @author Brian Wing Shun Chan
45   *
46   */
47  public interface PortletBag extends Cloneable {
48  
49      public Object clone();
50  
51      public ConfigurationAction getConfigurationActionInstance();
52  
53      public FriendlyURLMapper getFriendlyURLMapperInstance();
54  
55      public Indexer getIndexerInstance();
56  
57      public OpenSearch getOpenSearchInstance();
58  
59      public PollerProcessor getPollerProcessorInstance();
60  
61      public MessageListener getPopMessageListenerInstance();
62  
63      public Portlet getPortletInstance();
64  
65      public PortletLayoutListener getPortletLayoutListenerInstance();
66  
67      public String getPortletName();
68  
69      public PreferencesValidator getPreferencesValidatorInstance();
70  
71      public ResourceBundle getResourceBundle(Locale locale);
72  
73      public Map<String, ResourceBundle> getResourceBundles();
74  
75      public Scheduler getSchedulerInstance();
76  
77      public ServletContext getServletContext();
78  
79      public URLEncoder getURLEncoderInstance();
80  
81      public void setPortletInstance(Portlet portletInstance);
82  
83      public void setPortletName(String portletName);
84  
85  }