| LiferayPortletURL.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 *
5 *
6 *
7 * The contents of this file are subject to the terms of the Liferay Enterprise
8 * Subscription License ("License"). You may not use this file except in
9 * compliance with the License. You can obtain a copy of the License by
10 * contacting Liferay, Inc. See the License for the specific language governing
11 * permissions and limitations under the License, including but not limited to
12 * distribution rights 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.Set;
28
29 import javax.portlet.PortletURL;
30 import javax.portlet.ResourceURL;
31
32 /**
33 * <a href="LiferayPortletURL.java.html"><b><i>View Source</i></b></a>
34 *
35 * @author Brian Wing Shun Chan
36 */
37 public interface LiferayPortletURL
38 extends PortletURL, ResourceURL, Serializable {
39
40 public void addParameterIncludedInPath(String name);
41
42 public String getLifecycle();
43
44 public String getParameter(String name);
45
46 public String getPortletId();
47
48 public String getResourceID();
49
50 public boolean isAnchor();
51
52 public boolean isCopyCurrentRenderParameters();
53
54 public boolean isEncrypt();
55
56 public boolean isEscapeXml();
57
58 public boolean isParameterIncludedInPath(String name);
59
60 public boolean isSecure();
61
62 public void setLifecycle(String lifecycle);
63
64 public void setParameter(String name, String value, boolean append);
65
66 public void setParameter(String name, String[] values, boolean append);
67
68 public Set<String> getParametersIncludedInPath();
69
70 public void setAnchor(boolean anchor);
71
72 public void setCopyCurrentRenderParameters(
73 boolean copyCurrentRenderParameters);
74
75 public void setDoAsUserId(long doAsUserId);
76
77 public void setEncrypt(boolean encrypt);
78
79 public void setEscapeXml(boolean escapeXml);
80
81 public void setPlid(long plid);
82
83 public void setPortletId(String portletId);
84
85 }