Package de.hybris.platform.core.initialization

Class SystemSetupParameter

  • public class SystemSetupParameter
extends java.lang.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 Summary

      Constructors 
      Constructor Description
      SystemSetupParameter​(java.lang.String key)
      This key will be available again in the ParameterMap after the request was sent.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addValue​(java.lang.String value)
      Adds a value to the parameter.
      void addValue​(java.lang.String value, boolean selected)
      Adds a value to the parameter with the possibility to set the selected status.
      void addValues​(java.lang.String[] values)
      Adds a whole string array as values to the parameter.
      java.lang.String[] getDefaults()  
      java.lang.String getKey()  
      java.lang.String getLabel()  
      java.util.Map<java.lang.String,​java.lang.Boolean> getValues()  
      boolean isDefault​(java.lang.String parameter)  
      boolean isMultiSelect()  
      void setLabel​(java.lang.String label)
      This label will be displayed in the administration console (hac) before the select box.
      void setMultiSelect​(boolean multiSelect)  
      void setSelected​(java.lang.String value)
      Tags the value to be selected (default value).

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SystemSetupParameter

        public SystemSetupParameter​(java.lang.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 Detail

      • addValue

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

      • setSelected

        public void setSelected​(java.lang.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​(java.lang.String value)
        Adds a value to the parameter.

      • addValues

        public void addValues​(java.lang.String[] values)
        Adds a whole string array as values to the parameter.

      • getValues

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

      • getKey

        public java.lang.String getKey()

      • isDefault

        public boolean isDefault​(java.lang.String parameter)
        Returns:
        Returns true if the parameter is a default parameter.

      • getDefaults

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

      • setLabel

        public void setLabel​(java.lang.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 java.lang.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