com.ibm.portal.admin
Interface SkinModelLocator<E extends java.lang.Object & Skin>

All Superinterfaces:

Locator<E>

public interface SkinModelLocator<E extends java.lang.Object & Skin>
extends Locator<E>

A locator the can be provided by SkinList implementations. The locator is optionally implemented by a skin list.

Code example:

 final SkinList list = ...;
 final Locator loc = list.getLocator();
 if (loc instanceof SkinModelLocator) {
     final SkinModelLocator locator = (SkinModelLocator) loc;
     final Skin defaultSkin = locator.getDefaultForTheme(aTheme);
 }
 

Since:

5.1.0.1

Method Summary

ListModel<E>	getAllInTheme(Theme aTheme) Returns all skins that belong to the specified theme.
ListModel<E>	getAllInThemes(java.util.Iterator<? extends Theme> aThemes) Returns all skins that belong to the specified themes.
ListModel<E>	getAllOfType(SkinType aType) Deprecated. this method is deprecated without replacement Returns all skins that are of a certain skin type.
Skin	getDefaultForTheme(Theme aTheme) Returns the default skin for the given theme.

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

getAllOfType

ListModel<E> getAllOfType(SkinType aType)
                                                         throws ModelException,
                                                                DataException

Deprecated. this method is deprecated without replacement Returns all skins that are of a certain skin type.

Returns:

a list model with all skins of a given skin type.

Throws:

DataException - if a database error occurs while accessing the data backend

ModelException - if an error occured while accessing model information

getAllInTheme

ListModel<E> getAllInTheme(Theme aTheme)
                                                          throws ModelException,
                                                                 DataException

Returns all skins that belong to the specified theme.

Parameters:

aTheme - the theme for which to return all associated skins

Returns:

a list model of skin objects that belong to the specified theme.

Throws:

ModelException - if an error occured while accessing model information

DataException - if the default skins cannot be retrieved, due to a database error.

getAllInThemes

ListModel<E> getAllInThemes(java.util.Iterator<? extends Theme> aThemes)
                                                           throws ModelException,
                                                                  DataException

Returns all skins that belong to the specified themes.

Parameters:

aThemes - an iterator holding only themes objects

Returns:

a list model of skin objects that belong to at least one of the specified themes

Throws:

ModelException - if an error occured while accessing model information

DataException - The default skins cannot be retrieved, due to a database error.

getDefaultForTheme

Skin getDefaultForTheme(Theme aTheme)
                        throws ModelException,
                               DataException

Returns the default skin for the given theme.

Parameters:

aTheme - The theme object.

Returns:

the default skin, or null if there is no default skin

Throws:

ModelException - if an error occured while accessing model information

DataException - if the default skin cannot be retrieved, due to a database error.