org.ametys.runtime.parameter

Class Parameter<T extends Enum<T>>

java.lang.Object

org.ametys.runtime.parameter.Parameter<T>

Type Parameters:

T - the actual parameter type.

Direct Known Subclasses:

AbstractSearchUIColumn, AbstractSearchUICriterion, ConfigParameter, JdbcParameter, MetadataDefinition, ServiceParameter, SiteParameter, SkinParameter, UserPreference

public class Parameter<T extends Enum<T>>
extends Object

A parameter is defined with the following properties:

id

id of the parameter, must be unique

pluginName

the plugin name defining this parameter

label

the label (can be i18nized)

description

the description (can be i18nized)

type

the type

widget

the optional widget to use for rendering

enumerator

the optional enumerator

validator

the optional validator

defaultValue

the default value

Field Summary

Fields

Modifier and Type	Field and Description
private Object	_defaultValue
private I18nizableText	_description
private Enumerator	_enumerator
private String	_id
private I18nizableText	_label
private String	_pluginName
private T	_type
private Validator	_validator
private String	_widget
private Map<String,I18nizableText>	_widgetParams

Constructor Summary

Constructors

Constructor and Description
Parameter()

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue() Retrieves the default value.
I18nizableText	getDescription() Retrieves the description.
Enumerator	getEnumerator() Retrieves the enumerator.
String	getId() Get the id.
I18nizableText	getLabel() Retrieves the label.
String	getPluginName() Retrieves the name of the plugin declaring this parameter.
T	getType() Retrieves the type.
Validator	getValidator() Retrieves the validator.
String	getWidget() Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters() Get the widget's parameters
void	setDefaultValue(Object defaultValue) Set the default value.
void	setDescription(I18nizableText description) Set the description.
void	setEnumerator(Enumerator enumerator) Set the enumerator.
void	setId(String id) Set the id.
void	setLabel(I18nizableText label) Set the label.
void	setPluginName(String pluginName) Set the name of the plugin declaring this parameter.
void	setType(T type) Set the type.
void	setValidator(Validator validator) Set the validator.
void	setWidget(String widget) Set the widget.
void	setWidgetParameters(Map<String,I18nizableText> params) Set the widget's parameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_id

private String _id

_pluginName

private String _pluginName

_label

private I18nizableText _label

_description

private I18nizableText _description

_type

private T extends Enum<T> _type

_widget

private String _widget

_widgetParams

private Map<String,I18nizableText> _widgetParams

_enumerator

private Enumerator _enumerator

_validator

private Validator _validator

_defaultValue

private Object _defaultValue

Constructor Detail

Parameter

public Parameter()

Method Detail

getId

public String getId()

Get the id.

Returns:

Returns the id.

setId

public void setId(String id)

Set the id.

Parameters:

id - the id.

getPluginName

public String getPluginName()

Retrieves the name of the plugin declaring this parameter.

Returns:

the plugin name.

setPluginName

public void setPluginName(String pluginName)

Set the name of the plugin declaring this parameter.

Parameters:

pluginName - the plugin name.

getLabel

public I18nizableText getLabel()

Retrieves the label.

Returns:

the label.

setLabel

public void setLabel(I18nizableText label)

Set the label.

Parameters:

label - the label.

getDescription

public I18nizableText getDescription()

Retrieves the description.

Returns:

the description.

setDescription

public void setDescription(I18nizableText description)

Set the description.

Parameters:

description - the description.

getType

public T getType()

Retrieves the type.

Returns:

the type.

setType

public void setType(T type)

Set the type.

Parameters:

type - the type.

getWidget

public String getWidget()

Retrieves the widget to use for rendering.

Returns:

the widget or null if none is defined.

setWidget

public void setWidget(String widget)

Set the widget.

Parameters:

widget - the widget.

getWidgetParameters

public Map<String,I18nizableText> getWidgetParameters()

Get the widget's parameters

Returns:

the widget's parameters

setWidgetParameters

public void setWidgetParameters(Map<String,I18nizableText> params)

Set the widget's parameters

Parameters:

params - the parameters to set

getEnumerator

public Enumerator getEnumerator()

Retrieves the enumerator.

Returns:

the enumerator or null if none is defined.

setEnumerator

public void setEnumerator(Enumerator enumerator)

Set the enumerator.

Parameters:

enumerator - the enumerator.

getValidator

public Validator getValidator()

Retrieves the validator.

Returns:

the validator or null if none is defined.

setValidator

public void setValidator(Validator validator)

Set the validator.

Parameters:

validator - the validator.

getDefaultValue

public Object getDefaultValue()

Retrieves the default value.

Returns:

the default value or null if none is defined.

setDefaultValue

public void setDefaultValue(Object defaultValue)

Set the default value.

Parameters:

defaultValue - the default value.