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 PortletSettings

public interface PortletSettings

The PortletSettings interface provides the portlet with its dynamic configuration. The configuration holds information about the portlet that is valid per concrete portlet for all users, and is maintained by the administrator. The portlet can therefore only read the dynamic configuration. Only when the portlet is in CONFIGURE mode, it has write access to the dynamic configuration data

Since:

4.1

See Also:

Portlet

Method Summary
PortletApplicationSettings	getApplicationSettings() Returns the portlet application settings
java.lang.String	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.
java.util.Locale	getDefaultLocale() Returns the portlet's default locale.
java.lang.String	getName() Returns the name of the concrete portlet.
java.lang.String	java.util.Locale, org.apache.jetspeed.portlet.Client)">getTitle(java.util.Locale locale, Client client) Returns the title of this window.
void	removeAttribute(java.lang.String name) Removes the attribute with the given name.
void	setAttribute(java.lang.String name, java.lang.String value) Sets the attribute with the given name and value.
void	store() Stores all attributes.

Method Detail

getName

public java.lang.String getName()

Returns the name of the concrete portlet.

Returns:

the portlet name

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns the portlet's default locale.

Returns:

the default locale

java.util.Locale, org.apache.jetspeed.portlet.Client)">

getTitle

public java.lang.String getTitle(java.util.Locale locale,
                                 Client client)

Returns the title of this window. This method returns only a static title from the portlet configuration.

Parameters:

locale - the locale

client - the client

Returns:

the text of the portlet title

setAttribute

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

Sets the attribute with the given name and value.

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.String 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

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

getApplicationSettings

public PortletApplicationSettings getApplicationSettings()

Returns the portlet application settings

Returns:

the portlet application settings