com.novell.afw.portlet.api
Interface EbiPortletPreferenceLocalized

All Superinterfaces:

Cloneable, EbiPortletPreference

public interface EbiPortletPreferenceLocalized

extends EbiPortletPreference

Interface to represent a single localized portlet preference. TODO: more JavaDoc

Since:

v5.0

Fields inherited from interface com.novell.afw.portlet.api.EbiPortletPreference

TYPE_BOOLEAN, TYPE_COMPLEX, TYPE_INTEGER, TYPE_PASSWORD, TYPE_SELECT, TYPE_STRING

Method Summary

EbiPortletPreference	getBasePreference() Returns the preference to which this localized preference uses as its base and the preference to which the non localized properties are delegated (e.g.
EbiPortletPreference	getDisplayBasePreference() Returns the preference to which this localized preference uses as its base for the displayname and description property.
EbiPortletPreference	getValuesBasePreference() Returns the preference to which this localized preference uses as its base for the values property.
boolean	isDescriptionLocalized() Indicates if the description of the preference is localized and will not delegate to the base preference.
boolean	isDisplayNameLocalized() Indicates if the display name of the preference is localized and will not delegate to the base preference.
boolean	isLocalized() Indicates that any of the localiziable properties have been localized.
boolean	isValuesLocalized() Indicates if the value of the preference is localized and will not delegate to the base preference.
void	resetLocalization() Resets all the localization, so that all localizable fields delegate to thier respective targets.

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

getDataType, getDescription, getDisplayableXML, getDisplayName, getLocale, getName, getValue, getValue, getValues, getValues, isEncrypted, isHiddenFromUser, isMultiValued, isReadOnly, isRequired, setDescription, setDisplayName, setHiddenFromUser, setMultiValued, setReadOnly, setRequired, setValue, setValues, validate

Method Detail

getBasePreference

public EbiPortletPreference getBasePreference()

Returns the preference to which this localized preference uses as its base and the preference to which the non localized properties are delegated (e.g. required, multi-valued, datatype, etc)

Returns:

EbiPortletPreference which is the delegation target.

Since:

v5.0

getValuesBasePreference

public EbiPortletPreference getValuesBasePreference()

Returns the preference to which this localized preference uses as its base for the values property.

Returns:

EbiPortletPreference which is the delegation target.

Since:

v5.0

getDisplayBasePreference

public EbiPortletPreference getDisplayBasePreference()

Returns the preference to which this localized preference uses as its base for the displayname and description property.

Returns:

EbiPortletPreference which is the delegation target.

Since:

v5.0

resetLocalization

public void resetLocalization()

Resets all the localization, so that all localizable fields delegate to thier respective targets.

Since:

v5.0

isValuesLocalized

public boolean isValuesLocalized()

Indicates if the value of the preference is localized and will not delegate to the base preference.

Returns:

true if the value has been set, and no longer delegates.

Since:

v5.0

isDisplayNameLocalized

public boolean isDisplayNameLocalized()

Indicates if the display name of the preference is localized and will not delegate to the base preference.

Returns:

true if the display name has been set, and no longer delegates.

Since:

v5.0

isDescriptionLocalized

public boolean isDescriptionLocalized()

Indicates if the description of the preference is localized and will not delegate to the base preference.

Returns:

true if the description has been set, and no longer delegates.

Since:

v5.0

isLocalized

public boolean isLocalized()

Indicates that any of the localiziable properties have been localized.

Returns:

the semantic result of isDescriptionLocalized() || isDisplayNameLocalized() || isValuesLocalized()

Since:

v5.0