com.ibm.mashups.enabler
Interface ModifiableLocalized

All Superinterfaces:

Localized

public ModifiableLocalized
extends Localized

Modifiable interface providing methods to set title and description of a resource.

Method Summary

String	setTitle(String title, String locale) Sets the title for the given locale.
Boolean	confirmSetTitle(String title, String locale) Confirms whether setting the title for the given locale is possible.
void	removeTitle(String locale) Removes the title for the given locale.
Boolean	confirmRemoveTitle(String locale) Indicates if the title for the specified locale may be removed.
void	removeTitles() Removes all titles.
Boolean	confirmRemoveTitles() Indicates if the titles for all locales may be removed.
String	setDescription(String desc, String locale) Sets the description for the given locale.
Boolean	confirmSetDescription(String desc, String locale) Confirms whether setting the description for the given locale is possible.
void	removeDescription(String locale) Removes the description for the given locale.
Boolean	confirmRemoveDescription(String locale) Indicates if the description for the specified locale may be removed.
void	removeDescriptions() Removes all description.
Boolean	confirmRemoveDescriptions() Indicates if the description for all locales may be removed.

Methods inherited from interface com.ibm.mashups.enabler.Localized

getLocales, getTitle, getTitles, getDescription, getDescriptions

Method Detail

setTitle

String setTitle(String title,
                String locale)

Sets the title for the given locale.

Parameters:

title - title to set; must not be null

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

Returns:

the former title; if none existed, null is returned

confirmSetTitle

Boolean confirmSetTitle(String title,
                        String locale)

Confirms whether setting the title for the given locale is possible.

Parameters:

title - title to set; must not be null

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

Returns:

true if the value can be set, otherwise false.

removeTitle

void removeTitle(String locale)

Removes the title for the given locale.

Parameters:

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

confirmRemoveTitle

Boolean confirmRemoveTitle(String locale)

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

Parameters:

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

Returns:

true if the title can be removed, otherwise false.

removeTitles

void removeTitles()

Removes all titles.

confirmRemoveTitles

Boolean confirmRemoveTitles()

Indicates if the titles for all locales may be removed.

Returns:

true if all titles can be removed, otherwise false.

setDescription

String setDescription(String desc,
                      String locale)

Sets the description for the given locale.

Parameters:

desc - description to set; must not be null

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

Returns:

the former description; if none existed, null is returned

confirmSetDescription

Boolean confirmSetDescription(String desc,
                              String locale)

Confirms whether setting the description for the given locale is possible.

Parameters:

desc - description to set; must not be null

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

Returns:

true if the value can be set, otherwise false.

removeDescription

void removeDescription(String locale)

Removes the description for the given locale.

Parameters:

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

confirmRemoveDescription

Boolean confirmRemoveDescription(String locale)

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

Parameters:

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

Returns:

true if the description can be removed, otherwise false.

removeDescriptions

void removeDescriptions()

Removes all description.

confirmRemoveDescriptions

Boolean confirmRemoveDescriptions()

Indicates if the description for all locales may be removed.

Returns:

true if all descriptions can be removed, otherwise false.