org.apache.jetspeed.portlet
Interface PortletSettings


Deprecated. since 6.0. Support of the IBM portlet API may be removed in a future release of WebSphere Portal. Use of the Java Portlet API (javax.portlet) is recommended instead.

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()
          Deprecated. Returns the portlet application settings
 java.lang.String getAttribute(java.lang.String name)
          Deprecated. Returns the value of the attribute with the given name, or null if no such attribute exists.
 java.util.Enumeration getAttributeNames()
          Deprecated. Returns an enumeration of all available attributes names.
 java.util.Locale getDefaultLocale()
          Deprecated. Returns the portlet's default locale.
 java.lang.String getName()
          Deprecated. Returns the name of the concrete portlet.
 java.lang.String getTitle(java.util.Locale locale, Client client)
          Deprecated. Returns the title of this window.
 void removeAttribute(java.lang.String name)
          Deprecated. Removes the attribute with the given name.
 void setAttribute(java.lang.String name, java.lang.String value)
          Deprecated. Sets the attribute with the given name and value.
 void store()
          Deprecated. Stores all attributes.
 

Method Detail

getName

java.lang.String getName()
Deprecated. 
Returns the name of the concrete portlet.

Returns:
the portlet name

getDefaultLocale

java.util.Locale getDefaultLocale()
Deprecated. 
Returns the portlet's default locale.

Returns:
the default locale

getTitle

java.lang.String getTitle(java.util.Locale locale,
                          Client client)
Deprecated. 
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

void setAttribute(java.lang.String name,
                  java.lang.String value)
                  throws AccessDeniedException
Deprecated. 
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

java.lang.String getAttribute(java.lang.String name)
Deprecated. 
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

java.util.Enumeration getAttributeNames()
Deprecated. 
Returns an enumeration of all available attributes names.

Returns:
an enumeration of attribute names
See Also:
getAttribute(String)

removeAttribute

void removeAttribute(java.lang.String name)
                     throws AccessDeniedException
Deprecated. 
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

void store()
           throws AccessDeniedException,
                  java.io.IOException
Deprecated. 
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

PortletApplicationSettings getApplicationSettings()
Deprecated. 
Returns the portlet application settings

Returns:
the portlet application settings