| LiferayPortletURL.java |
1 /**
2 * Copyright (c) 2000-2007 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 java.io.Serializable;
26
27 import java.util.Map;
28 import java.util.Set;
29
30 import javax.portlet.PortletMode;
31 import javax.portlet.PortletURL;
32 import javax.portlet.WindowState;
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 extends PortletURL, Serializable {
41
42 public String getPortletId();
43
44 public void setPortletId(String portletId);
45
46 public boolean isAction();
47
48 public void setAction(boolean action);
49
50 public WindowState getWindowState();
51
52 public PortletMode getPortletMode();
53
54 public String getParameter(String name);
55
56 public void setParameter(String name, String value, boolean append);
57
58 public void setParameter(String name, String[] values, boolean append);
59
60 public Map getParameterMap();
61
62 public Set getParametersIncludedInPath();
63
64 public void addParameterIncludedInPath(String name);
65
66 public boolean isParameterIncludedInPath(String name);
67
68 public boolean isSecure();
69
70 public boolean isAnchor();
71
72 public void setAnchor(boolean anchor);
73
74 public boolean isEncrypt();
75
76 public void setEncrypt(boolean encrypt);
77
78 public void setDoAsUserId(long doAsUserId);
79
80 }