Class SystemSetupParameter
java.lang.Object
de.hybris.platform.core.initialization.SystemSetupParameter
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
ConstructorsConstructorDescriptionThis key will be available again in the ParameterMap after the request was sent. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a value to the parameter.voidAdds a value to the parameter with the possibility to set the selected status.voidAdds a whole string array as values to the parameter.String[]getKey()getLabel()booleanbooleanvoidThis label will be displayed in the administration console (hac) before the select box.voidsetMultiSelect(boolean multiSelect) voidsetSelected(String value) Tags the value to be selected (default value).
-
Constructor Details
-
SystemSetupParameter
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
Adds a value to the parameter with the possibility to set the selected status. -
setSelected
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
Adds a value to the parameter. -
addValues
Adds a whole string array as values to the parameter. -
getValues
- Returns:
- Returns a values map with the name as key and the selected status as value.
-
getKey
-
isDefault
- Returns:
- Returns
trueif the parameter is a default parameter.
-
getDefaults
- Returns:
- Returns all default parameter in a string array.
-
setLabel
This label will be displayed in the administration console (hac) before the select box. If empty, the key will be used. -
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
-