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