com.ibm.workplace.wcm.api.plugin.rendering
Interface ValueOption

All Superinterfaces:

Localized

All Known Implementing Classes:

ValueOptionAdapter, ValueOptionImpl

public interface ValueOption
extends Localized

Represents the definition of a RenderingPluginParameter's allowed value.

This class extends Localized which is documented in the WebSphere Portal documentation. The getTitle(Locale) and getDescription(Locale) methods should return a translated title and description for the allowed value.

Since:

8.0.0.1 CF9

See Also:

ValueOptionAdapter

Note:

This interface is designed to be implemented by clients.

Method Summary

java.lang.String	getDescription(java.util.Locale locale) Get the translated description of the value option.
java.lang.String	getName() Returns the name for this value option.
java.lang.String	getTitle(java.util.Locale locale) Get the translated title of the value option.

Methods inherited from interface com.ibm.portal.Localized

getLocales

Method Detail

getName

java.lang.String getName()

Returns the name for this value option. This is the String that should be used as the value itself. Therefore, this should be a short String containing only alphanumeric characters. It must not contains spaces or special characters.

Note: If the name is changed, this will break the tags where the previous name of the value option is used.

Returns:

Name of the value option

getTitle

java.lang.String getTitle(java.util.Locale locale)

Get the translated title of the value option.

Specified by:

getTitle in interface Localized

Parameters:

locale - the locale for which to retrieve the title, must not be null.

Returns:

the title of this node in the given locale. If a title is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism.

See Also:

Localized.getTitle(java.util.Locale)

getDescription

java.lang.String getDescription(java.util.Locale locale)

Get the translated description of the value option.

Specified by:

getDescription in interface Localized

Parameters:

locale - the locale for which to retrieve the description, must not be null.

Returns:

the description of this node in the given locale. If a description is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism

See Also:

Localized.getDescription(java.util.Locale)