com.ibm.portal.admin
Interface Decoration

All Superinterfaces:

ActiveFlag, Identifiable, Localized, TimeStamped

All Known Subinterfaces:

ModifiableDecoration, ModifiableSkin, ModifiableTheme, Skin, Theme

public interface Decoration
extends Localized, TimeStamped, Identifiable, ActiveFlag

Model interface for attributes that are common to themes and skins. This interface can be used to retrieve information about a installed theme or skin.

A decoration object has the following data:

Resource root directory (required)

specifies the relative directory where the resources are located.

Activation flag (required)

denotes if this decoration object is active or not. Inactive themes and skins can be administered, but are ignored during rendering.

Default flag (required)

denotes if this decoration object is the portal default.

The object that implements this interface represents one theme or skin definition that has been registered with the portal. A theme or skin object can be obtained with the methods of a ThemeList or SkinList.

Since:

5.1.0.1

Method Summary

java.lang.String	getContextRoot() Returns the context root under which the decoration is deployed.
java.util.Locale	getDefaultLocale() Returns the default locale for the decoration
java.lang.String	getResourceRoot() Returns the resource root directory of the decoration.
boolean	isActive() Returns whether or not the decoration is active.
boolean	isDefault() Returns whether or not the decoration is the default decoration.
boolean	isSystem() Deprecated. there is no replacement for this method Returns whether or not the decoration is a system decoration.

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Methods inherited from interface com.ibm.portal.TimeStamped

getCreated, getLastModified

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Method Detail

getResourceRoot

java.lang.String getResourceRoot()
                                 throws ModelException

Returns the resource root directory of the decoration. This is part of the relative path in the portal installation; e.g. for themes this could be "WebSphere" or "Engineering", for skins this could be "Album" or "Shadow".

Returns:

the resource root directory, never null

Throws:

ModelException - if an error occured while accessing model information

getContextRoot

java.lang.String getContextRoot()
                                throws ModelException

Returns the context root under which the decoration is deployed. For backward compatibility, this methods returns null, if the decoration is installed with the portal web application (wps.war). Otherwise, the context root must match with the web application as installed in the application server and includes the leading slash.

Returns:

the context root, or null if the decoration is packaged with the portal

Throws:

ModelException - if an error occured while accessing model information

Since:

6.1.0

isActive

boolean isActive()
                 throws ModelException

Returns whether or not the decoration is active. Inactive decorations can be administered but are ignored during rendering.

Specified by:

isActive in interface ActiveFlag

Returns:

the current state; true if active, false otherwise.

Throws:

ModelException - if an error occured while accessing model information

isSystem

boolean isSystem()
                 throws ModelException

Deprecated. there is no replacement for this method Returns whether or not the decoration is a system decoration.

Returns:

the current state; true if it is a system decoration, false otherwise.

Throws:

ModelException - if an error occured while accessing model information

isDefault

boolean isDefault()
                  throws ModelException

Returns whether or not the decoration is the default decoration.

Returns:

the current state; true if it is a default decoration, false otherwise.

Throws:

ModelException - if an error occured while accessing model information

getDefaultLocale

java.util.Locale getDefaultLocale()
                                  throws ModelException

Returns the default locale for the decoration

Returns:

the default locale, null if no default is defined.

Throws:

ModelException - if an error occured while accessing model information