KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > DefaultPortletAction


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" and
27  * "Apache Jetspeed" must not be used to endorse or promote products
28  * derived from this software without prior written permission. For
29  * written permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache" or
32  * "Apache Jetspeed", nor may "Apache" appear in their name, without
33  * prior written permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */
54
55 package org.apache.jetspeed.portlet;
56
57 import java.util.Hashtable JavaDoc;
58 import java.util.Map JavaDoc;
59
60 /**
61  * The <CODE>DefaultPortletAction</CODE> is a portlet action with
62  * default parameters. You can use this portlet action to pass
63  * parameters in your action or create your own portlet action. This
64  * default implementation demonstrates how to implement it.
65  *
66  * @author <A HREF="mailto:shesmer@raleigh.ibm.com">Stephan Hesmer</A>
67  * @see PortletAction
68  */
69 public class DefaultPortletAction implements PortletAction
70 {
71     /**
72      * the name of this action
73      */
74     private String JavaDoc name = null;
75     /**
76      * all parameters passed by this action
77      */
78     private Hashtable JavaDoc parameters = null;
79
80     public DefaultPortletAction(String JavaDoc name)
81     {
82         this.name = name;
83         parameters = new Hashtable JavaDoc();
84     }
85
86     /**
87      * Returns the name of this action
88      *
89      * @return the name as a string
90      */
91     public String JavaDoc getName()
92     {
93         return name;
94     }
95
96     /**
97      * Adds a parameters to this action
98      *
99      * @param name the name of the new parameter
100      * @param value the value of the new parameter
101      */
102     public void addParameter(String JavaDoc name, Object JavaDoc value)
103     {
104         parameters.put(name, value);
105     }
106
107     /**
108      * Returns all parameters
109      *
110      * @return all parameters as map
111      */
112     public Map JavaDoc getParameters()
113     {
114         return parameters;
115     }
116
117 }
118
Popular Tags