001    /**
002     * Copyright (c) 2000-present 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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.atom.AtomCollectionAdapter;
020    import com.liferay.portal.kernel.notifications.UserNotificationDefinition;
021    import com.liferay.portal.kernel.notifications.UserNotificationHandler;
022    import com.liferay.portal.kernel.poller.PollerProcessor;
023    import com.liferay.portal.kernel.pop.MessageListener;
024    import com.liferay.portal.kernel.scheduler.messaging.SchedulerEventMessageListener;
025    import com.liferay.portal.kernel.search.Indexer;
026    import com.liferay.portal.kernel.search.OpenSearch;
027    import com.liferay.portal.kernel.servlet.URLEncoder;
028    import com.liferay.portal.kernel.template.TemplateHandler;
029    import com.liferay.portal.kernel.trash.TrashHandler;
030    import com.liferay.portal.kernel.webdav.WebDAVStorage;
031    import com.liferay.portal.kernel.workflow.WorkflowHandler;
032    import com.liferay.portal.kernel.xmlrpc.Method;
033    import com.liferay.portal.security.permission.PermissionPropagator;
034    import com.liferay.portlet.ControlPanelEntry;
035    import com.liferay.portlet.asset.model.AssetRendererFactory;
036    import com.liferay.portlet.expando.model.CustomAttributesDisplay;
037    import com.liferay.portlet.exportimport.lar.PortletDataHandler;
038    import com.liferay.portlet.exportimport.lar.StagedModelDataHandler;
039    import com.liferay.portlet.social.model.SocialActivityInterpreter;
040    import com.liferay.portlet.social.model.SocialRequestInterpreter;
041    
042    import java.util.List;
043    import java.util.Locale;
044    import java.util.ResourceBundle;
045    
046    import javax.portlet.Portlet;
047    import javax.portlet.PreferencesValidator;
048    
049    import javax.servlet.ServletContext;
050    
051    /**
052     * @author Brian Wing Shun Chan
053     */
054    @ProviderType
055    public interface PortletBag extends Cloneable {
056    
057            public Object clone();
058    
059            public void destroy();
060    
061            public List<AssetRendererFactory<?>> getAssetRendererFactoryInstances();
062    
063            public List<AtomCollectionAdapter<?>> getAtomCollectionAdapterInstances();
064    
065            public List<ConfigurationAction> getConfigurationActionInstances();
066    
067            public List<ControlPanelEntry> getControlPanelEntryInstances();
068    
069            public List<CustomAttributesDisplay> getCustomAttributesDisplayInstances();
070    
071            public FriendlyURLMapperTracker getFriendlyURLMapperTracker();
072    
073            public List<Indexer<?>> getIndexerInstances();
074    
075            public List<OpenSearch> getOpenSearchInstances();
076    
077            public List<PermissionPropagator> getPermissionPropagatorInstances();
078    
079            public List<PollerProcessor> getPollerProcessorInstances();
080    
081            public List<MessageListener> getPopMessageListenerInstances();
082    
083            public List<PortletDataHandler> getPortletDataHandlerInstances();
084    
085            public Portlet getPortletInstance();
086    
087            public List<PortletLayoutListener> getPortletLayoutListenerInstances();
088    
089            public String getPortletName();
090    
091            public List<PreferencesValidator> getPreferencesValidatorInstances();
092    
093            public ResourceBundle getResourceBundle(Locale locale);
094    
095            public ResourceBundleTracker getResourceBundleTracker();
096    
097            public List<SchedulerEventMessageListener>
098                    getSchedulerEventMessageListeners();
099    
100            public ServletContext getServletContext();
101    
102            public List<SocialActivityInterpreter>
103                    getSocialActivityInterpreterInstances();
104    
105            public List<SocialRequestInterpreter>
106                    getSocialRequestInterpreterInstances();
107    
108            public List<StagedModelDataHandler<?>> getStagedModelDataHandlerInstances();
109    
110            public List<TemplateHandler> getTemplateHandlerInstances();
111    
112            public List<TrashHandler> getTrashHandlerInstances();
113    
114            public List<URLEncoder> getURLEncoderInstances();
115    
116            public List<UserNotificationDefinition>
117                    getUserNotificationDefinitionInstances();
118    
119            public List<UserNotificationHandler> getUserNotificationHandlerInstances();
120    
121            public List<WebDAVStorage> getWebDAVStorageInstances();
122    
123            public List<WorkflowHandler<?>> getWorkflowHandlerInstances();
124    
125            public List<Method> getXmlRpcMethodInstances();
126    
127            public void setPortletInstance(Portlet portletInstance);
128    
129            public void setPortletName(String portletName);
130    
131    }