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.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    /**
027     * @author Brian Wing Shun Chan
028     */
029    public interface PortletApp extends Serializable {
030    
031            public void addEventDefinition(EventDefinition eventDefinition);
032    
033            public void addPortlet(Portlet portlet);
034    
035            public void addPortletFilter(PortletFilter portletFilter);
036    
037            public void addPortletURLListener(PortletURLListener portletURLListener);
038    
039            public void addPublicRenderParameter(
040                    PublicRenderParameter publicRenderParameter);
041    
042            public void addPublicRenderParameter(String identifier, QName qName);
043    
044            public void addServletURLPatterns(Set<String> servletURLPatterns);
045    
046            public Map<String, String[]> getContainerRuntimeOptions();
047    
048            public String getContextPath();
049    
050            public Map<String, String> getCustomUserAttributes();
051    
052            public String getDefaultNamespace();
053    
054            public Set<EventDefinition> getEventDefinitions();
055    
056            public PortletFilter getPortletFilter(String filterName);
057    
058            public Set<PortletFilter> getPortletFilters();
059    
060            public List<Portlet> getPortlets();
061    
062            public PortletURLListener getPortletURLListener(String listenerClass);
063    
064            public Set<PortletURLListener> getPortletURLListeners();
065    
066            public PublicRenderParameter getPublicRenderParameter(String identifier);
067    
068            public String getServletContextName();
069    
070            public Set<String> getServletURLPatterns();
071    
072            public SpriteImage getSpriteImage(String fileName);
073    
074            public Set<String> getUserAttributes();
075    
076            public boolean isWARFile();
077    
078            public void setDefaultNamespace(String defaultNamespace);
079    
080            public void setSpriteImages(String spriteFileName, Properties properties);
081    
082            public void setWARFile(boolean warFile);
083    
084    }