PortletPreferences Interface

DEPRECATED Replaced by PortletPreferences

com.bea.portlet.prefs
PortletPreferences Interface

public interface PortletPreferences

    extends PortletPreferences

The PortletPreferences interface represents preferences associated with a portlet instance.

Portlet preferences are name-value pairs of data. A named preference may have multiple values.

Portlet preferences may be specified at development time, be updated by portal administrators, and also be updated by portlets during actions.

A preference may be marked as read-only at deployment time. In such cases portlets can not modify such a preference. But administrators may still change the value of such a preference.


All Superinterfaces
PortletPreferences

Method Summary

public boolean
isModifiable(String key)

Returns true if the given preference is modifiable.

public void
setValue(String key, String value)

Sets the value of the given preference.

public void
setValues(String key, String[] values)

Sets the value of the given preference.

public void
store()

Stores the current set of preferences.

 
Methods from interface javax.portlet.PortletPreferences
getMap, getNames, getValue, getValues, isReadOnly, reset,
   

Method Detail

isModifiable(String) Method

DEPRECATED Use #isReadOnly

public boolean isModifiable(String key)

Returns true if the given preference is modifiable. Modifiable preferences can be modified by a portlet in any mode during its action-processing phase.

Parameters

key
name of the preference

Returns

boolean

setValue(String, String) Method

DEPRECATED Replaced by PortletPreferences.setValue(String, String)

public void setValue(String key, 
                     String value)
throws UnmodifiableException

Sets the value of the given preference.

Parameters

key
name of the preference
value
value to be set

Exceptions

UnmodifiableException
thrown if the preference is marked read-only

setValues(String, String[]) Method

DEPRECATED Replaced by PortletPreferences.setValues(String, String[])

public void setValues(String key, 
                      String[] values)
throws UnmodifiableException

Sets the value of the given preference.

Parameters

key
name of the preference
values
value to be set

Exceptions

UnmodifiableException
thrown if the preference is marked read-only

store() Method

DEPRECATED Replaced by PortletPreferences.store()

public void store()
throws IOException

Stores the current set of preferences.

Exceptions

IOException
thrown if there is an error while storing the preferences