PortalResponse


1   /*
2    * The Apache Software License, Version 1.1
3    *
4    * Copyright (c) 2001-2004 Caucho Technology, Inc.  All rights reserved.
5    *
6    * Redistribution and use in source and binary forms, with or without
7    * modification, are permitted provided that the following conditions
8    * are met:
9    *
10   * 1. Redistributions of source code must retain the above copyright
11   *    notice, this list of conditions and the following disclaimer.
12   *
13   * 2. Redistributions in binary form must reproduce the above copyright
14   *    notice, this list of conditions and the following disclaimer in
15   *    the documentation and/or other materials provided with the
16   *    distribution.
17   *
18   * 3. The end-user documentation included with the redistribution, if
19   *    any, must include the following acknowlegement:
20   *       "This product includes software developed by the
21   *        Caucho Technology (http://www.caucho.com/)."
22   *    Alternately, this acknowlegement may appear in the software itself,
23   *    if and wherever such third-party acknowlegements normally appear.
24   *
25   * 4. The names "Hessian", "Resin", and "Caucho" must not be used to
26   *    endorse or promote products derived from this software without prior
27   *    written permission. For written permission, please contact
28   *    info@caucho.com.
29   *
30   * 5. Products derived from this software may not be called "Resin"
31   *    nor may "Resin" appear in their names without prior written
32   *    permission of Caucho Technology.
33   *
34   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37   * DISCLAIMED.  IN NO EVENT SHALL CAUCHO TECHNOLOGY OR ITS CONTRIBUTORS
38   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
39   * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
40   * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
41   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
42   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43   * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
44   * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45   *
46   * @author Sam
47   */
48  
49  
50  package com.caucho.portal.generic;
51  
52  import javax.portlet.PortletMode;
53  import javax.portlet.PortletModeException;
54  import javax.portlet.WindowState;
55  import javax.portlet.WindowStateException;
56  import java.util.Map  ;
57  
58  /**
59   */
60  public interface PortalResponse
61  {
62    /**
63     * Set the portlet modes for a namespace.  
64     * If the portlet matching the namespace has already had processAction()
65     * or render() called on it,  an exception is thrown because it
66     * is too late to set the portlet mode.
67     *
68     * @throw IllegalStateException if it is too late in the processing of the
69     * request to set the portlet mode for the namespace
70     *
71     * @throw IllegalArgumentException if the namespace is not known
72     */
73    public void setPortletMode(String   namespace, PortletMode portletMode)
74      throws PortletModeException;
75  
76    /**
77     * Set the window state for a namespace.  
78     * If the portlet matching the namespace has already had processAction()
79     * or render() called on it,  an exception is thrown because it
80     * is too late to set the window state.
81     *
82     * @throw IllegalStateException if it is too late in the processing of the
83     * request to set the window state for the namespace
84     *
85     * @throw IllegalArgumentException if the namespace is not known
86     */
87    public void setWindowState(String   namespace, WindowState windowState)
88      throws WindowStateException;
89  
90    /**
91     * Set parameters for a namespace to the map.
92     * If the portlet matching the namespace has already had processAction()
93     * or render() called on it,  an exception is thrown because it
94     * is too late to set parameters.
95     *
96     * @throw IllegalStateException if it is too late in the processing of the
97     * request to set parameters for the namespace
98     *
99     * @throw IllegalArgumentException if the namespace is not known
100    */
101   public void setParameters(String   namespace, Map  <String  , String  []> srcMap);
102 
103   /**
104    * Set a Rparameter for a namespace.
105    * If the portlet matching the namespace has already had processAction()
106    * or render() called on it,  an exception is thrown because it
107    * is too late to set parameters.
108    *
109    * @throw IllegalStateException if it is too late in the processing of the
110    * request to set parameters for the namespace
111    *
112    * @throw IllegalArgumentException if the namespace is not known
113    */
114   public void setParameter(String   namespace, String   name, String   value);
115 
116   /**
117    * Set a parameter for a namespace.
118    * If the portlet matching the namespace has already had processAction()
119    * or render() called on it,  an exception is thrown because it
120    * is too late to set parameters.
121    *
122    * @throw IllegalStateException if it is too late in the processing of the
123    * request to set parameters for the namespace
124    *
125    * @throw IllegalArgumentException if the namespace is not known
126    */
127   public void setParameter(String   namespace, String   name, String  [] values);
128 
129   /**
130    * Create a render url to another namespace.
131    *
132    * @param keepParameters if true, then the render parameters that exist for
133    * the namespace for this request are maintained for the next request.
134    * If false, the url when first formed will have no parameters.
135    */
136   public PortalURL createRenderURL(String   namespace, boolean keepParameters);
137 
138   /**
139    * Create an action url that targets another namespace.
140    *
141    * @param isSticky if true, then the render parameters that exist for the
142    * namespace for this request are maintained for the next request.
143    * If false, the url when first formed will have no parameters.
144    */
145   public PortalURL createActionURL(String   namespace, boolean keepParameters);
146 
147 }
148
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags