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.model;
016    
017    import com.liferay.portal.kernel.xml.QName;
018    
019    import java.io.Serializable;
020    
021    import java.util.List;
022    import java.util.Map;
023    import java.util.Properties;
024    import java.util.Set;
025    
026    import javax.servlet.ServletContext;
027    
028    /**
029     * @author Brian Wing Shun Chan
030     */
031    public interface PortletApp extends Serializable {
032    
033            public void addEventDefinition(EventDefinition eventDefinition);
034    
035            public void addPortlet(Portlet portlet);
036    
037            public void addPortletFilter(PortletFilter portletFilter);
038    
039            public void addPortletURLListener(PortletURLListener portletURLListener);
040    
041            public void addPublicRenderParameter(
042                    PublicRenderParameter publicRenderParameter);
043    
044            public void addPublicRenderParameter(String identifier, QName qName);
045    
046            public void addServletURLPatterns(Set<String> servletURLPatterns);
047    
048            public Map<String, String[]> getContainerRuntimeOptions();
049    
050            public String getContextPath();
051    
052            public Map<String, String> getCustomUserAttributes();
053    
054            public String getDefaultNamespace();
055    
056            public Set<EventDefinition> getEventDefinitions();
057    
058            public PortletFilter getPortletFilter(String filterName);
059    
060            public Set<PortletFilter> getPortletFilters();
061    
062            public List<Portlet> getPortlets();
063    
064            public PortletURLListener getPortletURLListener(String listenerClass);
065    
066            public Set<PortletURLListener> getPortletURLListeners();
067    
068            public PublicRenderParameter getPublicRenderParameter(String identifier);
069    
070            public ServletContext getServletContext();
071    
072            public String getServletContextName();
073    
074            public Set<String> getServletURLPatterns();
075    
076            public SpriteImage getSpriteImage(String fileName);
077    
078            public Set<String> getUserAttributes();
079    
080            public boolean isWARFile();
081    
082            public void removePortlet(Portlet portletModel);
083    
084            public void setDefaultNamespace(String defaultNamespace);
085    
086            public void setServletContext(ServletContext servletContext);
087    
088            public void setSpriteImages(String spriteFileName, Properties properties);
089    
090            public void setWARFile(boolean warFile);
091    
092    }