KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > portal > server > PortalResponse


1 /*****************************************
2  * *
3  * JBoss Portal: The OpenSource Portal *
4  * *
5  * Distributable under LGPL license. *
6  * See terms of license at gnu.org. *
7  * *
8  *****************************************/

9 package org.jboss.portal.server;
10
11 import org.jboss.portal.server.output.Result;
12
13 import javax.servlet.http.HttpServletResponse JavaDoc;
14 import java.util.Iterator JavaDoc;
15
16 /**
17  * @author <a HREF="mailto:julien@jboss.org">Julien Viet</a>
18  * @version $Revision: 1.4 $
19  */

20 public interface PortalResponse extends HttpServletResponse JavaDoc
21 {
22
23    /**
24     * @see #createURL(ServerURL,Boolean,Boolean,boolean)
25     * @param url the portal url to encode
26     * @return the url
27     */

28    String JavaDoc createURL(ServerURL url, boolean relative);
29
30    /**
31     * Creates an URL targetting the specified object.
32     *
33     * If wantAuthenticated is not null then it imposes wether it is authenticated ot not, otherwise
34     * it reuses the value from the request.
35     *
36     * If wantSecure is not null then it imposes wether it issecure ot not, otherwise
37     * it reuses the value from the request.
38     *
39     * If relative is set to true, then the URL is relative to the server root, otherwise the URL is absolute.
40     *
41     * @param url the server url to encode
42     * @param wantAuthenticated
43     * @param wantSecure
44     * @param relative
45     * @return the url
46     * @throws IllegalArgumentException if the url is null
47     */

48    String JavaDoc createURL(ServerURL url, Boolean JavaDoc wantAuthenticated, Boolean JavaDoc wantSecure, boolean relative) throws IllegalArgumentException JavaDoc;
49
50    /**
51     * Set the result of the target.
52     *
53     * @param result the result of the target
54     */

55    void setTargetResult(Result result);
56
57    /**
58     * Return the result of the target.
59     *
60     * @return the result of the target
61     */

62    Result getTargetResult();
63
64    /**
65     * Add the given result to the render result set.
66     */

67    void addRenderResult(Result result);
68
69    /**
70     * Returns an iterator over the collected results.
71     *
72     * @return an iterator of the results
73     */

74    Iterator JavaDoc getRenderResults();
75
76 }
77
Popular Tags