com.ibm.portal.portletmodel
Interface PortletPreferencesProvider<E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>

All Superinterfaces:

MetaDataProvider<java.lang.String,E>

All Known Subinterfaces:

ModifiablePortlet, ModifiablePortletDefinition, ModifiablePortletEntity, Portlet, PortletDefinition, PortletEntity

public interface PortletPreferencesProvider<E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>
extends MetaDataProvider<java.lang.String,E>

An interface describing a method to obtain portlet preferences for a resource. Portlet preferences are not the same as metadata in general, but they may alternatively be accessed using the same interface, therefore this interface extends MetaDataProvider.

Since:

6.0.1

See Also:

PortletEntity, PortletDefinition

Method Summary

MetaData<java.lang.String,E>	getMetaData() Returns the same preferences as getPortletPreferencesLayer().
PortletPreferences<E>	getPortletPreferencesLayer() Returns the preferences layer that corresponds to the resource implementing the PortletPreferencesProvider

Method Detail

getMetaData

MetaData<java.lang.String,E> getMetaData()

Returns the same preferences as getPortletPreferencesLayer(). Note that the MetaData interface only allows access to the first value for multi-value preferences.

Specified by:

getMetaData in interface MetaDataProvider<java.lang.String,E extends java.lang.Object & java.util.Map.Entry<java.lang.String,java.lang.String>>

Returns:

an Implementation of MetaData that also implements PortletPreferences

See Also:

getPortletPreferencesLayer()

getPortletPreferencesLayer

PortletPreferences<E> getPortletPreferencesLayer()

Returns the preferences layer that corresponds to the resource implementing the PortletPreferencesProvider

Returns:

a portlet preferences layer; never returns null.