001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.kernel.portlet;
016    
017    import com.liferay.portal.kernel.lar.PortletDataHandler;
018    import com.liferay.portal.kernel.poller.PollerProcessor;
019    import com.liferay.portal.kernel.pop.MessageListener;
020    import com.liferay.portal.kernel.search.Indexer;
021    import com.liferay.portal.kernel.search.OpenSearch;
022    import com.liferay.portal.kernel.servlet.URLEncoder;
023    import com.liferay.portal.kernel.webdav.WebDAVStorage;
024    import com.liferay.portal.kernel.workflow.WorkflowHandler;
025    import com.liferay.portal.kernel.xmlrpc.Method;
026    import com.liferay.portlet.ControlPanelEntry;
027    import com.liferay.portlet.asset.model.AssetRendererFactory;
028    import com.liferay.portlet.expando.model.CustomAttributesDisplay;
029    import com.liferay.portlet.social.model.SocialActivityInterpreter;
030    import com.liferay.portlet.social.model.SocialRequestInterpreter;
031    
032    import java.util.List;
033    import java.util.Locale;
034    import java.util.Map;
035    import java.util.ResourceBundle;
036    
037    import javax.portlet.Portlet;
038    import javax.portlet.PreferencesValidator;
039    
040    import javax.servlet.ServletContext;
041    
042    /**
043     * @author Brian Wing Shun Chan
044     */
045    public interface PortletBag extends Cloneable {
046    
047            public Object clone();
048    
049            public List<AssetRendererFactory> getAssetRendererFactoryInstances();
050    
051            public ConfigurationAction getConfigurationActionInstance();
052    
053            public ControlPanelEntry getControlPanelEntryInstance();
054    
055            public List<CustomAttributesDisplay> getCustomAttributesDisplayInstances();
056    
057            public FriendlyURLMapper getFriendlyURLMapperInstance();
058    
059            public Indexer getIndexerInstance();
060    
061            public OpenSearch getOpenSearchInstance();
062    
063            public PollerProcessor getPollerProcessorInstance();
064    
065            public MessageListener getPopMessageListenerInstance();
066    
067            public PortletDataHandler getPortletDataHandlerInstance();
068    
069            public Portlet getPortletInstance();
070    
071            public PortletLayoutListener getPortletLayoutListenerInstance();
072    
073            public String getPortletName();
074    
075            public PreferencesValidator getPreferencesValidatorInstance();
076    
077            public ResourceBundle getResourceBundle(Locale locale);
078    
079            public Map<String, ResourceBundle> getResourceBundles();
080    
081            public ServletContext getServletContext();
082    
083            public SocialActivityInterpreter getSocialActivityInterpreterInstance();
084    
085            public SocialRequestInterpreter getSocialRequestInterpreterInstance();
086    
087            public URLEncoder getURLEncoderInstance();
088    
089            public WebDAVStorage getWebDAVStorageInstance();
090    
091            public List<WorkflowHandler> getWorkflowHandlerInstances();
092    
093            public Method getXmlRpcMethodInstance();
094    
095            public void setPortletInstance(Portlet portletInstance);
096    
097            public void setPortletName(String portletName);
098    
099    }