com.actional.plugin

Interface ISettingDescription

All Known Subinterfaces:

ISettingUIDescription

public interface ISettingDescription

Used for defining metadata for plug-in settings that should be exposed through the plug-in's UI.

Method Summary

Modifier and Type	Method and Description
ISettingUIDescription	setDefaultValue(java.lang.Object value) Sets the initial default value for this setting.
ISettingUIDescription	setDescription(java.lang.String value) Sets the description for this setting.
ISettingUIDescription	setIsEditable(boolean value) Sets the 'editable' flag for this setting.
ISettingUIDescription	setPossibleValues(java.lang.String[] values) Provides a list of strings that will be used to restrict the input acceptable by this setting.
ISettingUIDescription	setRequired(boolean value) Sets the 'required' flag for this setting.

Method Detail

setRequired

ISettingUIDescription setRequired(boolean value)
                           throws java.lang.Exception

Sets the 'required' flag for this setting. If set to true, this will be used to indicate to the user that this setting is required and result in an error message if it is not populated.

Parameters:

value - true to mark this setting as required, false otherwise (Default: false)

Returns:

The updated ISettingDescription

Throws:

java.lang.Exception

setDescription

ISettingUIDescription setDescription(java.lang.String value)
                              throws java.lang.Exception

Sets the description for this setting.

Parameters:

value - the description associated with this setting

Returns:

The updated ISettingDescription

Throws:

java.lang.Exception

setIsEditable

ISettingUIDescription setIsEditable(boolean value)
                             throws java.lang.Exception

Sets the 'editable' flag for this setting. If set to true, this will be used to enforce that the setting can only be populated during the creation of the plug-in itself and not when then plug-in settings are subsequently edited.

Parameters:

value - true to mark this setting as editable, false otherwise. (Default: true)

Returns:

The updated ISettingDescription

Throws:

java.lang.Exception

setPossibleValues

ISettingUIDescription setPossibleValues(java.lang.String[] values)
                                 throws java.lang.Exception

Provides a list of strings that will be used to restrict the input acceptable by this setting. Typically, this will result in the display of a selection list rather than a text field.

Parameters:

values - List of possible values for this setting

Returns:

The updated ISettingDescription

Throws:

java.lang.Exception

setDefaultValue

ISettingUIDescription setDefaultValue(java.lang.Object value)
                               throws java.lang.Exception

Sets the initial default value for this setting.

Parameters:

value - The initial default value for the setting

Returns:

The updated ISettingDescription

Throws:

java.lang.Exception