| LiferayPortletURL.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * The contents of this file are subject to the terms of the Liferay Enterprise
5 * Subscription License ("License"). You may not use this file except in
6 * compliance with the License. You can obtain a copy of the License by
7 * contacting Liferay, Inc. See the License for the specific language governing
8 * permissions and limitations under the License, including but not limited to
9 * distribution rights of the Software.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17 * SOFTWARE.
18 */
19
20 package com.liferay.portal.kernel.portlet;
21
22 import java.io.Serializable;
23
24 import java.util.Set;
25
26 import javax.portlet.PortletURL;
27 import javax.portlet.ResourceURL;
28
29 /**
30 * <a href="LiferayPortletURL.java.html"><b><i>View Source</i></b></a>
31 *
32 * @author Brian Wing Shun Chan
33 *
34 */
35 public interface LiferayPortletURL
36 extends PortletURL, ResourceURL, Serializable {
37
38 public void addParameterIncludedInPath(String name);
39
40 public String getLifecycle();
41
42 public String getParameter(String name);
43
44 public String getPortletId();
45
46 public String getResourceID();
47
48 public boolean isAnchor();
49
50 public boolean isCopyCurrentRenderParameters();
51
52 public boolean isEncrypt();
53
54 public boolean isEscapeXml();
55
56 public boolean isParameterIncludedInPath(String name);
57
58 public boolean isSecure();
59
60 public void setLifecycle(String lifecycle);
61
62 public void setParameter(String name, String value, boolean append);
63
64 public void setParameter(String name, String[] values, boolean append);
65
66 public Set<String> getParametersIncludedInPath();
67
68 public void setAnchor(boolean anchor);
69
70 public void setCopyCurrentRenderParameters(
71 boolean copyCurrentRenderParameters);
72
73 public void setDoAsUserId(long doAsUserId);
74
75 public void setEncrypt(boolean encrypt);
76
77 public void setEscapeXml(boolean escapeXml);
78
79 public void setPlid(long plid);
80
81 public void setPortletId(String portletId);
82
83 }