001    /**
002     * Copyright (c) 2000-2010 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 java.io.Serializable;
018    
019    import java.util.Map;
020    import java.util.Set;
021    
022    import javax.portlet.PortletURL;
023    import javax.portlet.ResourceURL;
024    
025    /**
026     * @author Brian Wing Shun Chan
027     */
028    public interface LiferayPortletURL
029            extends PortletURL, ResourceURL, Serializable {
030    
031            public void addParameterIncludedInPath(String name);
032    
033            public String getLifecycle();
034    
035            public String getParameter(String name);
036    
037            public String getPortletId();
038    
039            public Map<String, String> getReservedParameterMap();
040    
041            public String getResourceID();
042    
043            public boolean isAnchor();
044    
045            public boolean isCopyCurrentRenderParameters();
046    
047            public boolean isEncrypt();
048    
049            public boolean isEscapeXml();
050    
051            public boolean isParameterIncludedInPath(String name);
052    
053            public boolean isSecure();
054    
055            public void setLifecycle(String lifecycle);
056    
057            public void setParameter(String name, String value, boolean append);
058    
059            public void setParameter(String name, String[] values, boolean append);
060    
061            public Set<String> getParametersIncludedInPath();
062    
063            public void setAnchor(boolean anchor);
064    
065            public void setCopyCurrentRenderParameters(
066                    boolean copyCurrentRenderParameters);
067    
068            public void setDoAsUserId(long doAsUserId);
069    
070            public void setDoAsUserLanguageId(String doAsUserLanguageId);
071    
072            public void setEncrypt(boolean encrypt);
073    
074            public void setEscapeXml(boolean escapeXml);
075    
076            public void setPlid(long plid);
077    
078            public void setPortletId(String portletId);
079    
080    }