Class SystemSetupParameter

java.lang.Object
de.hybris.platform.core.initialization.SystemSetupParameter

public class SystemSetupParameter extends Object
This class represents a single parameter used by the SystemSetup

All parameters will be displayed in the administration console (hac) on the initialization/update page. If multiselect is true, it will be shown as a multiselect window, otherwise as a normal html select box. During the init/update process called out of ant, all parameters will be filled with the default parameter.

  • Constructor Details

    • SystemSetupParameter

      public SystemSetupParameter(String key)
      This key will be available again in the ParameterMap after the request was sent. To avoid doubled parameter keys, the extension name and a '_' character is added.
  • Method Details

    • addValue

      public void addValue(String value, boolean selected)
      Adds a value to the parameter with the possibility to set the selected status.
    • setSelected

      public void setSelected(String value)
      Tags the value to be selected (default value). In the normal select box (multiselect = false) the last selected item will be selected as default.
    • addValue

      public void addValue(String value)
      Adds a value to the parameter.
    • addValues

      public void addValues(String[] values)
      Adds a whole string array as values to the parameter.
    • getValues

      public Map<String,Boolean> getValues()
      Returns:
      Returns a values map with the name as key and the selected status as value.
    • getKey

      public String getKey()
    • isDefault

      public boolean isDefault(String parameter)
      Returns:
      Returns true if the parameter is a default parameter.
    • getDefaults

      public String[] getDefaults()
      Returns:
      Returns all default parameter in a string array.
    • setLabel

      public void setLabel(String label)
      This label will be displayed in the administration console (hac) before the select box. If empty, the key will be used.
    • getLabel

      public String getLabel()
      Returns:
      Returns the label of the parameter. If the label is empty, the key will be returned.
    • setMultiSelect

      public void setMultiSelect(boolean multiSelect)
      Parameters:
      multiSelect - the multiSelect to set
    • isMultiSelect

      public boolean isMultiSelect()
      Returns:
      the multiSelect