com.ibm.portal.portlet.service.model
Interface PortletLocalizedContext

All Superinterfaces:

Identifiable, java.lang.Iterable<java.util.Locale>, IterableListModel<java.util.Locale>, ListModel<java.util.Locale>, LocaleCapable, LocalizedContext

public interface PortletLocalizedContext
extends LocalizedContext, Identifiable

Provides access to the LocalizedContext implementation inside a portlet and provides convenience methods for that portlet.

Since:

6.1.0

See Also:

PortletLocalizedContextHome

Method Summary

java.util.Map.Entry<java.util.Locale,java.lang.String>	getLocalizedDescription() Returns a fitting description of the portlet window based on the information the context was created with.
java.util.Map.Entry<java.util.Locale,java.lang.String>	getLocalizedKeywords() Returns a fitting keywords of the portlet window based on the information the context was created with.
java.util.Map.Entry<java.util.Locale,java.lang.String>	getLocalizedShortTitle() Returns a fitting short title of the portlet window based on the information the context was created with.
java.util.Map.Entry<java.util.Locale,java.lang.String>	getLocalizedString(java.lang.String key) Returns the localized string from the default resource bundle of the portlet
java.util.Map.Entry<java.util.Locale,java.lang.String>	getLocalizedTitle() Returns a fitting title of the portlet window based on the information the context was created with.
ObjectID	getObjectID() Returns the ObjectID of the portlet window
java.util.ResourceBundle	getResourceBundle() Gets the resource bundle defined by the portlet based on the information the context was created with.
ResourceBundleProvider	getResourceBundleProvider() Returns the resource bundle provider for the default resource bundle for the portlet
IterableListModel<java.util.Locale>	getSupportedLocales() Returns the list of locales supported by the portlet.

Methods inherited from interface com.ibm.portal.model.LocalizedContext

getDefaultLocale, getDescription, getLocalizedComparator, getLocalizedDescription, getLocalizedString, getLocalizedTitle, getPreferredLocale, getPreferredLocale, getPreferredLocale, getPreferredLocale, getPreferredLocales, getPreferredLocales, getPreferredLocales, getPreferredLocales, getPreferredSupportedLocale, getPreferredSupportedLocales, getResourceBundle, getResourceBundle, getTitle, iterator, sort, sort, toArray

Method Detail

getLocalizedDescription

java.util.Map.Entry<java.util.Locale,java.lang.String> getLocalizedDescription()

Returns a fitting description of the portlet window based on the information the context was created with.

Returns:

a description string, not null. Neither key nor value are null, but the value may be an empty string

Since:

7.0.0

getLocalizedKeywords

java.util.Map.Entry<java.util.Locale,java.lang.String> getLocalizedKeywords()

Returns a fitting keywords of the portlet window based on the information the context was created with.

Returns:

a keywords string, not null. Neither key nor value are null, but the value may be an empty string

Since:

7.0.0

getLocalizedShortTitle

java.util.Map.Entry<java.util.Locale,java.lang.String> getLocalizedShortTitle()

Returns a fitting short title of the portlet window based on the information the context was created with.

Returns:

a short title string, not null. Neither key nor value are null, but the value may be an empty string

Since:

7.0.0

getLocalizedString

java.util.Map.Entry<java.util.Locale,java.lang.String> getLocalizedString(java.lang.String key)

Returns the localized string from the default resource bundle of the portlet

Parameters:

key - key of the resource

Returns:

the localized value or null if a localization is not available

Since:

8.0

getLocalizedTitle

java.util.Map.Entry<java.util.Locale,java.lang.String> getLocalizedTitle()

Returns a fitting title of the portlet window based on the information the context was created with.

Returns:

a title string, not null. Neither key nor value are null, but the value may be an empty string

Since:

7.0.0

getObjectID

ObjectID getObjectID()

Returns the ObjectID of the portlet window

Specified by:

getObjectID in interface Identifiable

Returns:

the portlet window ID, not null

getResourceBundle

java.util.ResourceBundle getResourceBundle()

Gets the resource bundle defined by the portlet based on the information the context was created with.

Returns:

a resource bundle for the given base name and the default locale

Throws:

java.util.MissingResourceException - if no resource bundle for the specified base name can be found

getResourceBundleProvider

ResourceBundleProvider getResourceBundleProvider()

Returns the resource bundle provider for the default resource bundle for the portlet

Returns:

the provider

Since:

8.0.0.1

getSupportedLocales

IterableListModel<java.util.Locale> getSupportedLocales()

Returns the list of locales supported by the portlet.

Specified by:

getSupportedLocales in interface LocaleCapable

Specified by:

getSupportedLocales in interface LocalizedContext

Returns:

the list of locales, not null

Since:

7.0.0