Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.portlet
Interface PortletData

public interface PortletData

The PortletData contains information about the concrete portlet instance. Also, it is through the data that the portlet has access to the personalized data. The portlet can therefore only read the personalization data. Only when the portlet is in EDIT mode, it has write access to the personalization data.

Since:

4.1

Method Summary
java.lang.Object	getAttribute(java.lang.String name) Returns the value of the attribute with the given name, or null if no such attribute exists.
java.util.Enumeration	getAttributeNames() Returns an enumeration of all available attributes names.
void	removeAllAttributes() Deprecated. deprecated since version 1.1
void	removeAttribute(java.lang.String name) Removes the attribute with the given name.
void	setAttribute(java.lang.String name, java.lang.Object value) Sets the attribute with the given name and value.
void	store() Stores all attributes.

Method Detail

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)
                  throws AccessDeniedException

Sets the attribute with the given name and value. The value object must be serializable.

Parameters:

name - the attribute name

value - the attribute value

Throws:

AccessDeniedException - if the caller isn't authorized to access this data object

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Returns the value of the attribute with the given name, or null if no such attribute exists.

Parameters:

name - the attribute name

Returns:

the attribute value

getAttributeNames

public java.util.Enumeration getAttributeNames()

Returns an enumeration of all available attributes names.

Returns:

an enumeration of attribute names

See Also:

getAttribute(String)

removeAttribute

public void removeAttribute(java.lang.String name)
                     throws AccessDeniedException

Removes the attribute with the given name. If no such attribute exists, this method does nothing.

Parameters:

name - the attribute name

Throws:

AccessDeniedException - if the caller isn't authorized to access this data object

removeAllAttributes

public void removeAllAttributes()
                         throws AccessDeniedException

Deprecated. deprecated since version 1.1

Removes all attributes. If no attributes exist, this method does nothing.

Throws:

AccessDeniedException - if the caller isn't authorized to access this data object

store

public void store()
           throws AccessDeniedException,
                  java.io.IOException

Stores all attributes.

Throws:

AccessDeniedException - if the caller isn't authorized to access this data object

java.io.IOException - if the streaming causes an I/O problem