Package 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:
AbstractDefaultSearchCriterionDefinition, AbstractSearchUICriterion, UserPreference
@Deprecated public class Parameter<T extends Enum<T>> extends Object
Deprecated.
use ElementDefinition instead
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

  • Constructor Details

  • Method Details

    • getId

      public String getId()
      Deprecated.
      Get the id.
      Returns:
      Returns the id.

    • setId

      public void setId(String id)
      Deprecated.
      Set the id.
      Parameters:
      id - the id.

    • getPluginName

      public String getPluginName()
      Deprecated.
      Retrieves the name of the plugin declaring this parameter.
      Returns:
      the plugin name.

    • setPluginName

      public void setPluginName(String pluginName)
      Deprecated.
      Set the name of the plugin declaring this parameter.
      Parameters:
      pluginName - the plugin name.

    • getLabel

      public I18nizableText getLabel()
      Deprecated.
      Retrieves the label.
      Returns:
      the label.

    • setLabel

      public void setLabel(I18nizableText label)
      Deprecated.
      Set the label.
      Parameters:
      label - the label.

    • getDescription

      public I18nizableText getDescription()
      Deprecated.
      Retrieves the description.
      Returns:
      the description.

    • setDescription

      public void setDescription(I18nizableText description)
      Deprecated.
      Set the description.
      Parameters:
      description - the description.

    • getType

      public T getType()
      Deprecated.
      Retrieves the type.
      Returns:
      the type.

    • setType

      public void setType(T type)
      Deprecated.
      Set the type.
      Parameters:
      type - the type.

    • getWidget

      public String getWidget()
      Deprecated.
      Retrieves the widget to use for rendering.
      Returns:
      the widget or null if none is defined.

    • setWidget

      public void setWidget(String widget)
      Deprecated.
      Set the widget.
      Parameters:
      widget - the widget.

    • getWidgetParameters

      public Map<String,I18nizableText> getWidgetParameters()
      Deprecated.
      Get the widget's parameters
      Returns:
      the widget's parameters

    • setWidgetParameters

      public void setWidgetParameters(Map<String,I18nizableText> params)
      Deprecated.
      Set the widget's parameters
      Parameters:
      params - the parameters to set

    • getEnumerator

      public Enumerator getEnumerator()
      Deprecated.
      Retrieves the enumerator.
      Returns:
      the enumerator or null if none is defined.

    • setEnumerator

      public void setEnumerator(Enumerator enumerator)
      Deprecated.
      Set the enumerator.
      Parameters:
      enumerator - the enumerator.

    • getValidator

      public Validator getValidator()
      Deprecated.
      Retrieves the validator.
      Returns:
      the validator or null if none is defined.

    • setValidator

      public void setValidator(Validator validator)
      Deprecated.
      Set the validator.
      Parameters:
      validator - the validator.

    • getDefaultValue

      public Object getDefaultValue()
      Deprecated.
      Retrieves the default value.
      Returns:
      the default value or null if none is defined.

    • setDefaultValue

      public void setDefaultValue(Object defaultValue)
      Deprecated.
      Set the default value.
      Parameters:
      defaultValue - the default value.