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

All Superinterfaces:

RenderingPluginParameterType

public interface StringInListRenderingPluginParameterType
extends RenderingPluginParameterType

The RenderingPluginParameterType for an parameter that can take a single string from a discrete number of strings as its value.

Since:

8.0.0.1 CF9

Note:

This interface is designed to be implemented by clients.

Method Summary

java.util.List<ValueOption>	getAllowedValues() The allowed values of the parameter.
java.lang.String	getDefaultValue() Get the name of the default value option of the parameter.

Method Detail

getAllowedValues

java.util.List<ValueOption> getAllowedValues()

The allowed values of the parameter.

Returns:

A list of the allowed parameter values options

getDefaultValue

java.lang.String getDefaultValue()

Get the name of the default value option of the parameter. This should be the value of ValueOption.getName() for the ValueOptions that is returned by getAllowedValues(). If null, the first parameter value in the list will be used as the default.

Returns:

the default parameter value, or null