01: /*
02: * Copyright (c) 1998-2004 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: * Free SoftwareFoundation, Inc.
23: * 59 Temple Place, Suite 330
24: * Boston, MA 02111-1307 USA
25: *
26: * @author Sam
27: */
28:
29: package javax.portlet;
30:
31: import java.io.IOException;
32: import java.util.Map;
33:
34: /**
35: * The <code>ActionResponse</code> is the request interface available to the
36: * portlet in the portlet's preocessAction method.
37: *
38: * @see ActionRequest
39: * @see PortletResponse
40: */
41: public interface ActionResponse extends PortletResponse {
42: public void setWindowState(WindowState state)
43: throws WindowStateException;
44:
45: public void setPortletMode(PortletMode portletMode)
46: throws PortletModeException;
47:
48: /**
49: * Send a response to the client that redirects the client to another
50: * location.
51: *
52: * <code>location</code> must be an absolute URL ("http://myserver/...") or
53: * a URI with a full path ("/myapp/mypath"). This method may encode the URL
54: * before the redirect is sent to the client.
55: *
56: * <code>path</code> may also be a relative path ("images/myimage.gif"), in
57: * which case it is a url to a resource in the current "portal", typically a
58: * path relative to the current webapp. Allowing a relative path is an
59: * extension of the behaviour defined by the portlet specification.
60: *
61: * An IllegalStateException is thrown if any of the following methods have
62: * been called:
63: *
64: * <ul>
65: * <li>setPortletMode
66: * <li>setWindowState
67: * <li>setRenderParameter
68: * <li>setRenderParameters
69: * </ul>
70: *
71: * @see javax.portlet.ActionResponse#sendRedirect
72: */
73: public void sendRedirect(String location) throws IOException;
74:
75: public void setRenderParameters(Map parameters);
76:
77: public void setRenderParameter(String key, String value);
78:
79: public void setRenderParameter(String key, String[] values);
80: }
|