| LiferayPortletURL.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portal.kernel.portlet;
24
25 import com.sun.portal.container.ChannelURLType;
26
27 import java.io.Serializable;
28
29 import java.util.Set;
30
31 import javax.portlet.PortletURL;
32 import javax.portlet.ResourceURL;
33
34 /**
35 * <a href="LiferayPortletURL.java.html"><b><i>View Source</i></b></a>
36 *
37 * @author Brian Wing Shun Chan
38 *
39 */
40 public interface LiferayPortletURL
41 extends PortletURL, ResourceURL, Serializable {
42
43 public void addParameterIncludedInPath(String name);
44
45 public String getLifecycle();
46
47 public String getParameter(String name);
48
49 public String getPortletId();
50
51 public String getResourceID();
52
53 public boolean isAnchor();
54
55 public boolean isCopyCurrentRenderParameters();
56
57 public boolean isEncrypt();
58
59 public boolean isEscapeXml();
60
61 public boolean isParameterIncludedInPath(String name);
62
63 public boolean isSecure();
64
65 public void setLifecycle(String lifecycle);
66
67 public void setParameter(String name, String value, boolean append);
68
69 public void setParameter(String name, String[] values, boolean append);
70
71 public Set<String> getParametersIncludedInPath();
72
73 public void setAnchor(boolean anchor);
74
75 public void setCopyCurrentRenderParameters(
76 boolean copyCurrentRenderParameters);
77
78 public void setDoAsUserId(long doAsUserId);
79
80 public void setDoAsUserLanguageId(String doAsUserLanguageId);
81
82 public void setEncrypt(boolean encrypt);
83
84 public void setEscapeXml(boolean escapeXml);
85
86 public void setPlid(long plid);
87
88 public void setPortletId(String portletId);
89
90 public void setURLType(ChannelURLType urlType);
91
92 }