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.SchedulerEntry;
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.dynamicdatamapping.util.DDMDisplay;
037    import com.liferay.portlet.expando.model.CustomAttributesDisplay;
038    import com.liferay.portlet.exportimport.lar.PortletDataHandler;
039    import com.liferay.portlet.exportimport.lar.StagedModelDataHandler;
040    import com.liferay.portlet.social.model.SocialActivityInterpreter;
041    import com.liferay.portlet.social.model.SocialRequestInterpreter;
042    
043    import java.util.List;
044    import java.util.Locale;
045    import java.util.ResourceBundle;
046    
047    import javax.portlet.Portlet;
048    import javax.portlet.PreferencesValidator;
049    
050    import javax.servlet.ServletContext;
051    
052    /**
053     * @author Brian Wing Shun Chan
054     */
055    @ProviderType
056    public interface PortletBag extends Cloneable {
057    
058            public Object clone();
059    
060            public void destroy();
061    
062            public List<AssetRendererFactory> getAssetRendererFactoryInstances();
063    
064            public List<AtomCollectionAdapter<?>> getAtomCollectionAdapterInstances();
065    
066            public List<ConfigurationAction> getConfigurationActionInstances();
067    
068            public List<ControlPanelEntry> getControlPanelEntryInstances();
069    
070            public List<CustomAttributesDisplay> getCustomAttributesDisplayInstances();
071    
072            public List<DDMDisplay> getDdmDisplayInstances();
073    
074            public FriendlyURLMapperTracker getFriendlyURLMapperTracker();
075    
076            public List<Indexer> getIndexerInstances();
077    
078            public List<OpenSearch> getOpenSearchInstances();
079    
080            public List<PermissionPropagator> getPermissionPropagatorInstances();
081    
082            public List<PollerProcessor> getPollerProcessorInstances();
083    
084            public List<MessageListener> getPopMessageListenerInstances();
085    
086            public List<PortletDataHandler> getPortletDataHandlerInstances();
087    
088            public Portlet getPortletInstance();
089    
090            public List<PortletLayoutListener> getPortletLayoutListenerInstances();
091    
092            public String getPortletName();
093    
094            public List<PreferencesValidator> getPreferencesValidatorInstances();
095    
096            public ResourceBundle getResourceBundle(Locale locale);
097    
098            public ResourceBundleTracker getResourceBundleTracker();
099    
100            public List<SchedulerEntry> getSchedulerEntryInstances();
101    
102            public ServletContext getServletContext();
103    
104            public List<SocialActivityInterpreter>
105                    getSocialActivityInterpreterInstances();
106    
107            public List<SocialRequestInterpreter>
108                    getSocialRequestInterpreterInstances();
109    
110            public List<StagedModelDataHandler<?>> getStagedModelDataHandlerInstances();
111    
112            public List<TemplateHandler> getTemplateHandlerInstances();
113    
114            public List<TrashHandler> getTrashHandlerInstances();
115    
116            public List<URLEncoder> getURLEncoderInstances();
117    
118            public List<UserNotificationDefinition>
119                    getUserNotificationDefinitionInstances();
120    
121            public List<UserNotificationHandler> getUserNotificationHandlerInstances();
122    
123            public List<WebDAVStorage> getWebDAVStorageInstances();
124    
125            public List<WorkflowHandler<?>> getWorkflowHandlerInstances();
126    
127            public List<Method> getXmlRpcMethodInstances();
128    
129            public void setPortletInstance(Portlet portletInstance);
130    
131            public void setPortletName(String portletName);
132    
133    }