com.ibm.portal.admin
Interface LanguageList<E extends Language>

Type Parameters:

E - the type model node this model exposes

All Superinterfaces:

Invalidatable, InvalidatableListModel<E>, ListModel<E>, LocatorProvider<E>, SearchableListModel<E>

public interface LanguageList<E extends Language>
extends ListModel<E>, LocatorProvider<E>, SearchableListModel<E>, InvalidatableListModel<E>

Model interface for the list of portal languages. This list provides all languages that the portal supports. Elements this model returns are Language objects.

Since:

5.1.0.1

Method Summary

E	getDefault() Returns the Language object representing the default language of the portal.
E	getLanguage(java.util.Locale aLocale) Returns a Language object supporting the given locale.

Methods inherited from interface com.ibm.portal.LocatorProvider

getLocator

Methods inherited from interface com.ibm.portal.ListModel

iterator

Methods inherited from interface com.ibm.portal.Invalidatable

invalidate, invalidate

Method Detail

getLanguage

E getLanguage(java.util.Locale aLocale)
                               throws ModelException,
                                      DataException,
                                      ObjectNotFoundException

Returns a Language object supporting the given locale. No locale fallback mechanism is applied.

Parameters:

aLocale - The locale that the returned element supports

Returns:

a Language element supporting the given locale, never null

Throws:

ModelException - if an error occured while accessing model information

DataException - if data retrieval fails

ObjectNotFoundException - if no language for the given locale exists

getDefault

E getDefault()
                              throws ModelException,
                                     DataException

Returns the Language object representing the default language of the portal.

Returns:

a Language element, or null if no default is set.

Throws:

ModelException - if an error occured while accessing model information

DataException - if data retrieval fails