Overview Package Class Tree Serialized Deprecated Index Help PREV class NEXT class SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.portal
Interface Localized
- All Known Subinterfaces:
- PortalURL
- All Known Implementing Classes:
- LocalizedException, LocalizedInformation, LocalizedRuntimeException, ModelException, SerializationException, WpsException
- public interface Localized
Interface providing methods to obtain title and description of a portal resource. Please note that title or description are only returned if they are available in the requested locale. No fallback for locales is performed.
- Since:
- 5.1
Method Summary java.lang.String java.util.Locale)">getDescription(java.util.Locale aLocale)
Returns the description of this object in the given locale.ListModel getLocales()
Returns a list model containing the locales that are supported by this object.java.lang.String java.util.Locale)">getTitle(java.util.Locale aLocale)
Returns the title of this object in the given locale.java.util.Locale)">
Method Detail getTitle
public java.lang.String getTitle(java.util.Locale aLocale)
- Returns the title of this object in the given locale.
- Parameters:
- aLocale - the locale for which to retrieve the title, must not be
null.
- Returns:
- the title of this node in the given locale. If a title is not available in the given locale, this method will return
null. It is up to the invoker of the method to implement an appropriate fallback mechanism.
java.util.Locale)">getDescription
public java.lang.String getDescription(java.util.Locale aLocale)
- Returns the description of this object in the given locale.
- Parameters:
- aLocale - the locale for which to retrieve the description, must not be
null.
- Returns:
- the description of this node in the given locale. If a title is not available in the given locale, this method will return
null. It is up to the invoker of the method to implement an appropriate fallback mechanism
getLocales
public ListModel getLocales()
- Returns a list model containing the locales that are supported by this object. The presence of a locale in this list does not mean that a title and description is available, but rather that either one or both are available in that locale.
- Returns:
- a list of locales defined for this object, returns an empty ListModel if no locales are supported.
Overview Package Class Tree Serialized Deprecated Index Help PREV class NEXT class SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.
IBM is a trademark of the IBM Corporation in the United States, other countries, or both.