com.ibm.portal
Interface ModifiableLocalized

All Superinterfaces:

Localized, Modifiable

All Known Subinterfaces:

ModifiableContentLabel, ModifiableContentNode, ModifiableContentPage, ModifiableContentURL, ModifiableExternalContentURL, ModifiableInternalContentURL, ModifiablePortletDefinition

public interface ModifiableLocalized
extends Localized, Modifiable

An interface representing a modifiable localized instance.

Since:

6.1.0

Method Summary

boolean	confirmRemoveDescription(java.util.Locale aLocale) Indicates if the description for the specified locale may be removed.
boolean	confirmRemoveDescriptions() Indicates if the all descriptions may be removed.
boolean	confirmRemoveDescriptions(java.util.Collection<java.util.Locale> aCollection) Indicates if the descriptions for the specified locales may be removed.
boolean	confirmRemoveTitle(java.util.Locale aLocale) Indicates if the title for the specified locale may be removed.
boolean	confirmRemoveTitles() Indicates if all titles may be removed.
boolean	confirmRemoveTitles(java.util.Collection<java.util.Locale> aCollection) Indicates if the titles for the specified locales may be removed.
boolean	confirmRetainDescriptions(java.util.Collection aCollection) Indicates if the specified descriptions may be retained.
boolean	confirmRetainTitles(java.util.Collection<java.util.Locale> aCollection) Indicates if the specified titles may be retained.
boolean	confirmSetAll(Localized aLocalized) Indicates if the specified titles and descriptions may be retained.
boolean	confirmSetDescription(java.util.Locale aLocale, java.lang.String aDescription) Indicates if the specified description may be set.
boolean	confirmSetDescriptions(Localized aLocalized) Indicates if the specified descriptions may be set.
boolean	confirmSetTitle(java.util.Locale aLocale, java.lang.String aTitle) Indicates if the specified title may be set.
boolean	confirmSetTitles(Localized aLocalized) Indicates if the specified titles may be set.
java.lang.String	removeDescription(java.util.Locale aLocale) Removes the description for the given locale.
boolean	removeDescriptions() Removes all descriptions.
boolean	removeDescriptions(java.util.Collection<java.util.Locale> aCollection) Removes all descriptions for the Locales specified in the collection.
java.lang.String	removeTitle(java.util.Locale aLocale) Removes the title for the given locale.
boolean	removeTitles() Removes all titles.
boolean	removeTitles(java.util.Collection<java.util.Locale> aCollection) Removes all titles for the Locales specified in the collection.
boolean	retainDescriptions(java.util.Collection<java.util.Locale> aCollection) Retains descriptions for the Locales specified in the collection.
boolean	retainTitles(java.util.Collection<java.util.Locale> aCollection) Retains titles for the Locales specified in the collection.
boolean	setAll(Localized aLocalized) Sets all titles and descriptions found in the specified Localized instance.
java.lang.String	setDescription(java.util.Locale aLocale, java.lang.String aDescription) Sets the description for the given locale.
boolean	setDescriptions(Localized aLocalized) Sets the descriptions specified with the Localized.
java.lang.String	setTitle(java.util.Locale aLocale, java.lang.String aTitle) Sets the title for the given locale.
boolean	setTitles(Localized aLocalized) Sets the titles specified with the Localized.

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Method Detail

setTitle

java.lang.String setTitle(java.util.Locale aLocale,
                          java.lang.String aTitle)
                          throws CannotModifyPropertyException

Sets the title for the given locale.

Parameters:

aLocale - locale to set the title for; must not be null

aTitle - title to set

Returns:

the former title; if none existed, null is returned

Throws:

CannotModifyPropertyException - in case the title cannot be set

setTitles

boolean setTitles(Localized aLocalized)
                  throws CannotModifyPropertyException

Sets the titles specified with the Localized.

Parameters:

aLocalized - Localized to set

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a title specified with the Localized cannot be set; in this case the specified titles are set only partially

setDescription

java.lang.String setDescription(java.util.Locale aLocale,
                                java.lang.String aDescription)
                                throws CannotModifyPropertyException

Sets the description for the given locale.

Parameters:

aLocale - locale to set the description for; must not be null

aDescription - description to set

Returns:

the former description; if none existed, null is returned

Throws:

CannotModifyPropertyException - in case the description cannot be set

setDescriptions

boolean setDescriptions(Localized aLocalized)
                        throws CannotModifyPropertyException

Sets the descriptions specified with the Localized.

Parameters:

aLocalized - Localized to set

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a description specified with the Localized cannot be set; in this case the specified descriptions are set only partially

removeTitle

java.lang.String removeTitle(java.util.Locale aLocale)
                             throws CannotModifyPropertyException

Removes the title for the given locale.

Parameters:

aLocale - locale of the title to remove; must not be null

Returns:

the former title; if none existed, null is returned

Throws:

CannotModifyPropertyException - in case the title cannot be removed for the locale

removeTitles

boolean removeTitles(java.util.Collection<java.util.Locale> aCollection)
                     throws CannotModifyPropertyException

Removes all titles for the Locales specified in the collection.

Parameters:

aCollection - collection of Locales

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a title for a locale cannot be removed; in this case the titles are removed only partially

removeTitles

boolean removeTitles()
                     throws CannotModifyPropertyException

Removes all titles.

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a title cannot be removed; in this case the titles are removed only partially

removeDescription

java.lang.String removeDescription(java.util.Locale aLocale)
                                   throws CannotModifyPropertyException

Removes the description for the given locale.

Parameters:

aLocale - locale of the description to remove; must not be null

Returns:

the former description; if none existed, null is returned

Throws:

CannotModifyPropertyException - in case the description cannot be removed for the locale

removeDescriptions

boolean removeDescriptions(java.util.Collection<java.util.Locale> aCollection)
                           throws CannotModifyPropertyException

Removes all descriptions for the Locales specified in the collection.

Parameters:

aCollection - collection of Locales

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a description for a locale cannot be removed; in this case the descriptions are removed only partially

removeDescriptions

boolean removeDescriptions()
                           throws CannotModifyPropertyException

Removes all descriptions.

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a description cannot be removed; in this case the descriptions are removed only partially

retainTitles

boolean retainTitles(java.util.Collection<java.util.Locale> aCollection)
                     throws CannotModifyPropertyException

Retains titles for the Locales specified in the collection.

Parameters:

aCollection - Locales to retain titles for

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a title for a locale, which is not to be retained, cannot be removed; in this case the titles are removed only partially

retainDescriptions

boolean retainDescriptions(java.util.Collection<java.util.Locale> aCollection)
                           throws CannotModifyPropertyException

Retains descriptions for the Locales specified in the collection.

Parameters:

aCollection - Locales to retain descriptions for

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a description for a locale, which is not to be retained, cannot be removed; in this case the descriptions are removed only partially

setAll

boolean setAll(Localized aLocalized)
               throws CannotModifyPropertyException

Sets all titles and descriptions found in the specified Localized instance.

Parameters:

aLocalized - the localized object providing titles and descriptions

Returns:

true if this Localized was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a title or description cannot be set; in this case the titles and descriptions are set only partially.

confirmSetTitle

boolean confirmSetTitle(java.util.Locale aLocale,
                        java.lang.String aTitle)

Indicates if the specified title may be set.

Parameters:

aLocale - locale for which to indicate if the title may be set; must not be null

aTitle - title for which to indicate if it may be set

Returns:

true if setting the specified title for the specified locale can be performed, false otherwise

confirmSetTitles

boolean confirmSetTitles(Localized aLocalized)

Indicates if the specified titles may be set.

Parameters:

aLocalized - localalized for which to indicate if its titles may be set; must not be null

Returns:

true if the specified titles may be set, false otherwise

confirmSetDescription

boolean confirmSetDescription(java.util.Locale aLocale,
                              java.lang.String aDescription)

Indicates if the specified description may be set.

Parameters:

aLocale - locale for which to indicate if the description may be set; must not be null

aDescription - description for which to indicate if it may be set

Returns:

true if setting the specified description for the specified locale can be performed, false otherwise

confirmSetDescriptions

boolean confirmSetDescriptions(Localized aLocalized)

Indicates if the specified descriptions may be set.

Parameters:

aLocalized - localalized for which to indicate if its descriptions may be set; must not be null

Returns:

true if the specified descriptions may be set, false otherwise

confirmRemoveTitle

boolean confirmRemoveTitle(java.util.Locale aLocale)

Indicates if the title for the specified locale may be removed.

Parameters:

aLocale - locale for which to indicate if the title may be removed; must not be null

Returns:

true if the specified title for the specified locale may be removed, false otherwise

confirmRemoveTitles

boolean confirmRemoveTitles(java.util.Collection<java.util.Locale> aCollection)

Indicates if the titles for the specified locales may be removed.

Parameters:

aCollection - collection of Locales for which to indicate if the titles may be removed; must not be null

Returns:

true if the specified titles may be remvoed, false otherwise

confirmRemoveTitles

boolean confirmRemoveTitles()

Indicates if all titles may be removed.

Returns:

true if all titles may be removed, false otherwise

confirmRemoveDescription

boolean confirmRemoveDescription(java.util.Locale aLocale)

Indicates if the description for the specified locale may be removed.

Parameters:

aLocale - locale for which to indicate if the description may be removed; must not be null

Returns:

true if the description for the specified locale may be removed, false otherwise

confirmRemoveDescriptions

boolean confirmRemoveDescriptions(java.util.Collection<java.util.Locale> aCollection)

Indicates if the descriptions for the specified locales may be removed.

Parameters:

aCollection - collection of Locales for which to indicate if the descriptions may be removed; must not be null

Returns:

true if the specified descriptions may be removed, false otherwise

confirmRemoveDescriptions

boolean confirmRemoveDescriptions()

Indicates if the all descriptions may be removed.

Returns:

true if all descriptions may be removed, false otherwise

confirmRetainTitles

boolean confirmRetainTitles(java.util.Collection<java.util.Locale> aCollection)

Indicates if the specified titles may be retained.

Parameters:

aCollection - collection of Locales for which to indicate if the titles may be retained

Returns:

true if the specified titles may be retained, false otherwise

confirmRetainDescriptions

boolean confirmRetainDescriptions(java.util.Collection aCollection)

Indicates if the specified descriptions may be retained.

Parameters:

aCollection - collection of Locales for which to indicate if the descriptions may be retained

Returns:

true if the specified descriptions may be retained, false otherwise

confirmSetAll

boolean confirmSetAll(Localized aLocalized)

Indicates if the specified titles and descriptions may be retained.

Parameters:

aLocalized - localalized for which to indicate if the titles and descriptions may be set; must not be null

Returns:

true if the specified titles and descriptions may be set, false otherwise