com.novell.afw.portlet.api
Interface EbiPortletPreferencesInstanceType

All Superinterfaces:

Cloneable, EbiPortletPreferences, EbiPortletPreferencesWritable

public interface EbiPortletPreferencesInstanceType

extends EbiPortletPreferencesWritable

Interace used to represent a collection of preferences that are related to a single portlet instance. This scope of preferences are created during registration or assignment to a page in the portal, and are typically created by administrators.

Since:

v5.0

Method Summary

EbiPortletPreferenceLocalized

createLocalizedPreference(String name, Locale locale) Creates a localized version of a preference.

Methods implemented from interface com.novell.afw.portlet.api.EbiPortletPreferencesWritable

createPreference, overridePreference, removePreference

Methods implemented from interface com.novell.afw.portlet.api.EbiPortletPreferences

getAllPreferences, getDisplayableXML, getParentPreferences, getPreference, getPreferenceMap, isPreferenceInherited, toXML

Method Detail

createLocalizedPreference

public EbiPortletPreferenceLocalized createLocalizedPreference(String name,
                                                               Locale locale)
                                                        throws EboItemExistenceException

Creates a localized version of a preference. The default preference must exist at the instance level for the name passed in or an exception will be thrown. After the localized preference is created, it will be added to the collection of preferences. When you add a localization, it applies to whatever preference would be returned from getPreference(name,null). This means that localized preferences can use as thier base preference, a preference at a higher level of the hierarchy. However, it must be noted, that as soon as the base preference is overridden, the localized preference will point to the overridden preference as its base.

Parameters:

name - The name of the preference - default value must already exist.

locale - Locale object for the desired locale.

Returns:

localized copy of a preference.

Throws:

EboItemExistenceException - thrown if a default preference with the name supplied does not exist.

Since:

v5.0