com.ibm.portal.admin
Interface SkinList<T extends java.lang.Object & Skin>

All Superinterfaces:

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

All Known Subinterfaces:

SkinListController<T,M>

public interface SkinList<T extends java.lang.Object & Skin>
extends SearchableListModel<T>, InvalidatableListModel<T>

Model interface for a list of portal skins. A portal skin list represents a collection of objects that implement the Skin interface.

Since:

5.1.0.1

Method Summary

ListModel<T>	getAllInTheme(Theme aTheme) Deprecated. use the method of the SkinModelLocator; the locator can be obtained with LocatorProvider.getLocator(). Return all skins that belong to the specified theme
ListModel<T>	getAllInThemes(java.util.Iterator<? extends Theme> aThemes) Deprecated. use the method of the SkinModelLocator; the locator can be obtained with LocatorProvider.getLocator(). Return all skins that belong to the specified themes
ListModel<T>	getAllOfType(SkinType aType) Deprecated. use the method of the SkinModelLocator; the locator can be obtained with LocatorProvider.getLocator().
Skin	getDefault() Returns the portal default skin
Skin	getDefaultForTheme(Theme aTheme) Deprecated. use the method of the SkinModelLocator; the locator can be obtained with LocatorProvider.getLocator(). Return the default Skin for the denoted theme.
Skin	getSkin(ObjectID anObjectID) Deprecated. Use LocatorProvider#getLocator()#findByID()
ListModel<SkinType>	getTypes() Deprecated. this method is deprecated without replacement Returns a list model of SkinType objects that are defined for the skin list.

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

getDefault

Skin getDefault()
                throws ModelException,
                       DataException

Returns the portal default skin

Returns:

the default skin, or null if there is none is set

Throws:

ModelException - if an error occured while accessing model information

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

getSkin

Skin getSkin(ObjectID anObjectID)
             throws ModelException,
                    DataException,
                    ObjectNotFoundException

Deprecated. Use LocatorProvider#getLocator()#findByID()

Returns the skin with the specified object ID.

Parameters:

anObjectID - the object ID of the skin.

Returns:

the skin for the given object ID, never null

Throws:

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

ModelException - if an error occured while accessing model information

ObjectNotFoundException - if no skin for the given object ID exists, or the user has no permission to view this object.

getTypes

ListModel<SkinType> getTypes()
                             throws DataException

Deprecated. this method is deprecated without replacement Returns a list model of SkinType objects that are defined for the skin list.

Returns:

a list model containing SkinType objects that represent the skin types that are registered in the portal. May be an empty list, but never null.

Throws:

ModelException - if an error occured while accessing model information

DataException - A database error occurs while accessing the data backend

getAllOfType

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

Deprecated. use the method of the SkinModelLocator; the locator can be obtained with LocatorProvider.getLocator().

Returns:

ListModel containing all skins that represent a certain skin type.

Throws:

DataException - A database error occurs while accessing the data backend

ModelException - An error occurs while accessing the data backend

ObjectNotFoundException - The denoted Skin type does not exist.

getAllInTheme

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

Deprecated. use the method of the SkinModelLocator; the locator can be obtained with LocatorProvider.getLocator(). Return all skins that belong to the specified theme

Parameters:

aTheme - The theme.

Returns:

a ListModel holding skin objects that belong to the specified theme

Throws:

ModelException - An error occurs while accessing the data backend

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

getAllInThemes

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

Deprecated. use the method of the SkinModelLocator; the locator can be obtained with LocatorProvider.getLocator(). Return all skins that belong to the specified themes

Parameters:

aThemes - The themes.

Returns:

a ListModel holding skin objects that belong to the specified themes

Throws:

ModelException - An error occurs while accessing the data backend

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

See Also:

Skin

getDefaultForTheme

Skin getDefaultForTheme(Theme aTheme)
                        throws ModelException,
                               DataException

Deprecated. use the method of the SkinModelLocator; the locator can be obtained with LocatorProvider.getLocator(). Return the default Skin for the denoted theme.

Parameters:

aTheme - The theme object.

Returns:

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

Throws:

ModelException - An error occurs while accessing the data backend

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