KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > portal > generic > Invocation


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.WindowState;
54 import java.util.Map JavaDoc;
55
56
57 /**
58  */
59 public interface Invocation
60 {
61   /**
62    * Return true if this invocation is the target of an action
63    */
64   public boolean isActionTarget();
65
66   /**
67    * Return a map view of the parameters.
68    */
69   public Map JavaDoc<String JavaDoc, String JavaDoc[]> getParameterMap();
70
71   /**
72    * Return a map view of the parameters and then create a new
73    * empty parameter map for this invocation.
74    */
75   public Map JavaDoc<String JavaDoc, String JavaDoc[]> releaseParameterMap();
76
77   public WindowState getWindowState();
78
79   public void setWindowState(WindowState windowState);
80
81   public PortletMode getPortletMode();
82
83   public void setPortletMode(PortletMode portletMode);
84
85   /**
86    * Create and return an InvocationURL. The InvocationURL is initially
87    * a duplicate of the state of the Invocation's for every namespace,
88    * changes to the returned url have no effect on the originating
89    * Invocation's.
90    *
91    * The exception is parameters, the returned InvocationURL starts off
92    * with an empty parameter map for this invocation, but parameters for
93    * other invocations with different namespaces are preserved.
94    */
95   public InvocationURL createActionURL();
96
97   /**
98    * Create and return a InvocationURL. The InvocationURL is initially
99    * a duplicate of the state of the Invocation's for every namespace,
100    * changes to the returned url have no effect on the originating
101    * Invocation's.
102    *
103    * The exception is parameters, the returned InvocationURL starts off
104    * with an empty parameter map for this invocation, but parameters for
105    * other invocations with different namespaces are preserved.
106    */
107   public InvocationURL createRenderURL();
108 }
109
110
Popular Tags