001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.portlet;
016    
017    import com.liferay.portal.kernel.atom.AtomCollectionAdapter;
018    import com.liferay.portal.kernel.lar.PortletDataHandler;
019    import com.liferay.portal.kernel.poller.PollerProcessor;
020    import com.liferay.portal.kernel.pop.MessageListener;
021    import com.liferay.portal.kernel.search.Indexer;
022    import com.liferay.portal.kernel.search.OpenSearch;
023    import com.liferay.portal.kernel.servlet.URLEncoder;
024    import com.liferay.portal.kernel.webdav.WebDAVStorage;
025    import com.liferay.portal.kernel.workflow.WorkflowHandler;
026    import com.liferay.portal.kernel.xmlrpc.Method;
027    import com.liferay.portal.security.permission.PermissionPropagator;
028    import com.liferay.portlet.ControlPanelEntry;
029    import com.liferay.portlet.asset.model.AssetRendererFactory;
030    import com.liferay.portlet.expando.model.CustomAttributesDisplay;
031    import com.liferay.portlet.social.model.SocialActivityInterpreter;
032    import com.liferay.portlet.social.model.SocialRequestInterpreter;
033    
034    import java.util.List;
035    import java.util.Locale;
036    import java.util.Map;
037    import java.util.ResourceBundle;
038    
039    import javax.portlet.Portlet;
040    import javax.portlet.PreferencesValidator;
041    
042    import javax.servlet.ServletContext;
043    
044    /**
045     * @author Brian Wing Shun Chan
046     */
047    public interface PortletBag extends Cloneable {
048    
049            public Object clone();
050    
051            public List<AssetRendererFactory> getAssetRendererFactoryInstances();
052    
053            public List<AtomCollectionAdapter<?>> getAtomCollectionAdapterInstances();
054    
055            public ConfigurationAction getConfigurationActionInstance();
056    
057            public ControlPanelEntry getControlPanelEntryInstance();
058    
059            public List<CustomAttributesDisplay> getCustomAttributesDisplayInstances();
060    
061            public FriendlyURLMapper getFriendlyURLMapperInstance();
062    
063            public List<Indexer> getIndexerInstances();
064    
065            public OpenSearch getOpenSearchInstance();
066    
067            public PermissionPropagator getPermissionPropagatorInstance();
068    
069            public PollerProcessor getPollerProcessorInstance();
070    
071            public MessageListener getPopMessageListenerInstance();
072    
073            public PortletDataHandler getPortletDataHandlerInstance();
074    
075            public Portlet getPortletInstance();
076    
077            public PortletLayoutListener getPortletLayoutListenerInstance();
078    
079            public String getPortletName();
080    
081            public PreferencesValidator getPreferencesValidatorInstance();
082    
083            public ResourceBundle getResourceBundle(Locale locale);
084    
085            public Map<String, ResourceBundle> getResourceBundles();
086    
087            public ServletContext getServletContext();
088    
089            public SocialActivityInterpreter getSocialActivityInterpreterInstance();
090    
091            public SocialRequestInterpreter getSocialRequestInterpreterInstance();
092    
093            public URLEncoder getURLEncoderInstance();
094    
095            public WebDAVStorage getWebDAVStorageInstance();
096    
097            public List<WorkflowHandler> getWorkflowHandlerInstances();
098    
099            public Method getXmlRpcMethodInstance();
100    
101            public void setPortletInstance(Portlet portletInstance);
102    
103            public void setPortletName(String portletName);
104    
105    }