KickJava   Java API By Example, From Geeks To Geeks.

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


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.Enumeration JavaDoc;
58
59 /**
60  * The <CODE>PortletData</CODE> contains information about the virtual
61  * instance of a portlet. Also, it is through the data that the portlet has
62  * access to the personalized data.
63  *
64  * @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
65  */
66 public interface PortletData
67 {
68     /**
69      ** Sets the attribute with the given name and value.
70      **
71      ** @param name
72      ** the attribute name
73      ** @param value
74      ** the attribute value
75      **
76      ** @exception AccessDeniedException
77      ** if the caller isn't authorized to access
78      ** this data object
79      **/
80
81     public void setAttribute (String JavaDoc name, String JavaDoc value) throws AccessDeniedException;
82
83     /**
84      ** Returns the value of the attribute with the given name,
85      ** or <CODE>null</CODE> if no such attribute exists.
86      **
87      ** @param name
88      ** the attribute name
89      **
90      ** @return the attribute value
91      **
92      ** @exception AccessDeniedException
93      ** if the caller isn't authorized to access
94      ** this data object
95      **/
96
97     public String JavaDoc getAttribute (String JavaDoc name) throws AccessDeniedException;
98
99     /**
100      ** Returns an enumeration of all available attributes names.
101      **
102      ** @return an enumeration of attribute names
103      **
104      ** @exception AccessDeniedException
105      ** if the caller isn't authorized to access
106      ** this data object
107      **
108      ** @see #getAttribute(String)
109      **/
110
111     public Enumeration JavaDoc getAttributeNames () throws AccessDeniedException;
112
113     /**
114      ** Removes the attribute with the given name. If no such
115      ** attribute exists, this method does nothing.
116      **
117      ** @param name
118      ** the attribute name
119      **
120      ** @exception AccessDeniedException
121      ** if the caller isn't authorized to access
122      ** this data object
123      **/
124
125     public void removeAttribute (String JavaDoc name) throws AccessDeniedException;
126
127     /**
128      ** Removes all attributes. If no attributes exist, this method
129      ** does nothing.
130      **
131      ** @exception AccessDeniedException
132      ** if the caller isn't authorized to access
133      ** this data object
134      **/
135
136     public void removeAllAttributes () throws AccessDeniedException;
137
138 }
139
Popular Tags