com.ibm.portal.admin
Interface ModifiableDecoration

All Superinterfaces:

ActiveFlag, Decoration, Identifiable, Localized, Modifiable, ModifiableActiveFlag, ModifiableIdentifiable, ModifiableLocalized, TimeStamped

All Known Subinterfaces:

ModifiableSkin, ModifiableTheme

public interface ModifiableDecoration
extends Decoration, ModifiableLocalized, ModifiableIdentifiable, ModifiableActiveFlag

An interface representing a modifiable decoration instance.

Since:

6.1.0

Method Summary

boolean	confirmSetDefault() Indicates if the current decoration may be set as the default decoration.
boolean	confirmSetDefaultLocale(java.util.Locale aLocale) Indicates if the given Locale may be set as the default locale.
boolean	setDefault() Sets the current decoration as the default decoration.
java.util.Locale	setDefaultLocale(java.util.Locale aLocale) Sets the given locale as the default locale of this decoration.

Methods inherited from interface com.ibm.portal.admin.Decoration

getContextRoot, getDefaultLocale, getResourceRoot, isActive, isDefault, isSystem

Methods inherited from interface com.ibm.portal.TimeStamped

getCreated, getLastModified

Methods inherited from interface com.ibm.portal.ModifiableLocalized

confirmRemoveDescription, confirmRemoveDescriptions, confirmRemoveDescriptions, confirmRemoveTitle, confirmRemoveTitles, confirmRemoveTitles, confirmRetainDescriptions, confirmRetainTitles, confirmSetAll, confirmSetDescription, confirmSetDescriptions, confirmSetTitle, confirmSetTitles, removeDescription, removeDescriptions, removeDescriptions, removeTitle, removeTitles, removeTitles, retainDescriptions, retainTitles, setAll, setDescription, setDescriptions, setTitle, setTitles

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Methods inherited from interface com.ibm.portal.ModifiableIdentifiable

getModifiableObjectID

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Methods inherited from interface com.ibm.portal.ModifiableActiveFlag

confirmSetActive, setActive

Method Detail

setDefault

boolean setDefault()
                   throws CannotModifyPropertyException,
                          ModelException

Sets the current decoration as the default decoration.

Returns:

the former state of the default attribute, i. e. true if this decoration was the default decoration

Throws:

CannotModifyPropertyException - if the default state cannot be changed

ModelException

setDefaultLocale

java.util.Locale setDefaultLocale(java.util.Locale aLocale)
                                  throws CannotModifyPropertyException,
                                         ModelException

Sets the given locale as the default locale of this decoration.

Parameters:

aLocale - a locale which is to become the new default locale of this decoration, must not be null

Returns:

the former default locale or null if none has been set yet.

Throws:

CannotModifyPropertyException - if the default locale cannot be set as the new default

ModelException

confirmSetDefault

boolean confirmSetDefault()

Indicates if the current decoration may be set as the default decoration.

Returns:

true if the current decoration may be set as the default decoration, false otherwise

confirmSetDefaultLocale

boolean confirmSetDefaultLocale(java.util.Locale aLocale)

Indicates if the given Locale may be set as the default locale.

Parameters:

aLocale - locale to set as the default locale; must not be null

Returns:

true if the given locale may be set as the default locale, false otherwise