Uses of Class
org.openhab.core.config.core.ConfigDescriptionParameter

Packages that use ConfigDescriptionParameter

Package	Description
org.openhab.core.automation
org.openhab.core.automation.module.script.rulesupport.shared.simple
org.openhab.core.automation.template
org.openhab.core.automation.type
org.openhab.core.automation.util
org.openhab.core.config.core
org.openhab.core.config.core.dto
org.openhab.core.config.core.i18n
org.openhab.core.config.core.metadata
org.openhab.core.io.rest.core.config

Uses of ConfigDescriptionParameter in org.openhab.core.automation

Methods in org.openhab.core.automation that return types with arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
List<ConfigDescriptionParameter>	Rule.getConfigurationDescriptions()	This method is used to obtain the List with ConfigDescriptionParameters defining meta info for configuration properties of the Rule.

Uses of ConfigDescriptionParameter in org.openhab.core.automation.module.script.rulesupport.shared.simple

Fields in org.openhab.core.automation.module.script.rulesupport.shared.simple declared as ConfigDescriptionParameter

Modifier and Type	Field	Description
protected static final ConfigDescriptionParameter	SimpleRule.SCRIPT_TYPE_CONFIG_DESCRIPTION
protected static final ConfigDescriptionParameter	SimpleRule.SOURCE_CONFIG_DESCRIPTION

Fields in org.openhab.core.automation.module.script.rulesupport.shared.simple with type parameters of type ConfigDescriptionParameter

Modifier and Type	Field	Description
protected List<ConfigDescriptionParameter>	SimpleRule.configDescriptions

Methods in org.openhab.core.automation.module.script.rulesupport.shared.simple that return types with arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
List<ConfigDescriptionParameter>	SimpleRule.getConfigurationDescriptions()

Method parameters in org.openhab.core.automation.module.script.rulesupport.shared.simple with type arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
void	SimpleRule.setConfigurationDescriptions(@Nullable List<ConfigDescriptionParameter> configDescriptions)	This method is used to describe with ConfigDescriptionParameters the meta info for configuration properties of the Rule.

Uses of ConfigDescriptionParameter in org.openhab.core.automation.template

Methods in org.openhab.core.automation.template that return types with arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
List<ConfigDescriptionParameter>	RuleTemplate.getConfigurationDescriptions()	Gets the List with ConfigDescriptionParameters defining meta info for configuration properties of the future Rule instances.

Uses of ConfigDescriptionParameter in org.openhab.core.automation.type

Fields in org.openhab.core.automation.type with type parameters of type ConfigDescriptionParameter

Modifier and Type	Field	Description
protected List<ConfigDescriptionParameter>	ModuleType.configDescriptions	Describes meta-data for the configuration of the future Module instances.

Methods in org.openhab.core.automation.type that return types with arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
List<ConfigDescriptionParameter>	ModuleType.getConfigurationDescriptions()	Gets the meta-data for the configuration of the future Module instances.

Constructor parameters in org.openhab.core.automation.type with type arguments of type ConfigDescriptionParameter

Modifier	Constructor	Description
	ActionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable Visibility visibility, @Nullable List<Input> inputs, @Nullable List<Output> outputs)	Creates an instance of ActionType with uid, label, description, a Set of tags, visibility, a List of configuration descriptions, a List of Input descriptions and a List of Output descriptions.
	ActionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable List<Input> inputs)	Creates an instance of ActionType with base properties - UID, a List of configuration descriptions and a List of Input definitions.
	ActionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable List<Input> inputs, @Nullable List<Output> outputs)	Creates an instance of the ActionType with UID, a List of configuration descriptions, a List of Input definitions and a List of Output descriptions.
	CompositeActionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable Visibility visibility, @Nullable List<Input> inputs, @Nullable List<Output> outputs, @Nullable List<Action> children)	Creates an instance of CompositeActionType with list of Actions.
	CompositeActionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable List<Input> inputs, @Nullable List<Output> outputs, @Nullable List<Action> children)	Creates an instance of CompositeActionType with list of Actions.
	CompositeConditionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable Visibility visibility, @Nullable List<Input> inputs, @Nullable List<Condition> children)	Creates an instance of CompositeConditionType with ordered set of Conditions.
	CompositeConditionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable List<Input> inputs, @Nullable List<Condition> children)	Creates an instance of CompositeConditionType with ordered set of Conditions.
	CompositeTriggerType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable Visibility visibility, @Nullable List<Output> outputs, @Nullable List<Trigger> children)	Creates an instance of CompositeTriggerType with ordered set of Trigger modules.
	CompositeTriggerType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable List<Output> outputs, @Nullable List<Trigger> children)	Creates an instance of CompositeTriggerType with ordered set of Trigger modules.
	ConditionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable Visibility visibility, @Nullable List<Input> inputs)	Creates an instance of ConditionType with uid, label, description, a Set of tags, visibility, a List of configuration descriptions and a List of Input descriptions.
	ConditionType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable List<Input> inputs)	Creates an instance of ConditionType with base properties - UID, a List of configuration descriptions and a List of Input descriptions.
	ModuleType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions)	Creates a ModuleType instance.
	ModuleType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable Visibility visibility)	Creates a ModuleType instance.
	TriggerType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable Visibility visibility, @Nullable List<Output> outputs)	Creates an instance of TriggerType with UID, label, description, a Set of tags, visibility, a List of configuration descriptions and a List of Output descriptions.
	TriggerType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable List<Output> outputs)	Creates an instance of TriggerType with base properties - UID, a List of configuration descriptions and a List of Output descriptions.

Uses of ConfigDescriptionParameter in org.openhab.core.automation.util

Methods in org.openhab.core.automation.util that return ConfigDescriptionParameter

Modifier and Type	Method	Description
ConfigDescriptionParameter	ActionInputsHelper.mapActionInputToConfigDescriptionParameter(Input input)	Maps an Input to a ConfigDescriptionParameter.

Methods in org.openhab.core.automation.util that return types with arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
static Map<String,ConfigDescriptionParameter>	ConfigurationNormalizer.getConfigDescriptionMap(List<ConfigDescriptionParameter> configDesc)	Converts a list of ConfigDescriptionParameters to a map with the parameter's names as keys.
List<ConfigDescriptionParameter>	ActionInputsHelper.mapActionInputsToConfigDescriptionParameters(List<Input> inputs)	Maps a list of Inputs to a list of ConfigDescriptionParameters.

Method parameters in org.openhab.core.automation.util with type arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
static Map<String,ConfigDescriptionParameter>	ConfigurationNormalizer.getConfigDescriptionMap(List<ConfigDescriptionParameter> configDesc)	Converts a list of ConfigDescriptionParameters to a map with the parameter's names as keys.
static void	ConfigurationNormalizer.normalizeConfiguration(Configuration configuration, Map<String,ConfigDescriptionParameter> configDescriptionMap)	Normalizes the types of the configuration's parameters to the allowed ones.
RuleBuilder	RuleBuilder.withConfigurationDescriptions(@Nullable List<ConfigDescriptionParameter> configDescs)

Uses of ConfigDescriptionParameter in org.openhab.core.config.core

Methods in org.openhab.core.config.core that return ConfigDescriptionParameter

Modifier and Type	Method	Description
ConfigDescriptionParameter	ConfigDescriptionParameterBuilder.build()	Builds a result with the settings of this builder.

Methods in org.openhab.core.config.core that return types with arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
List<ConfigDescriptionParameter>	ConfigDescription.getParameters()	Returns the corresponding ConfigDescriptionParameters.
Map<String,ConfigDescriptionParameter>	ConfigDescription.toParametersMap()	Returns a map representation of the ConfigDescriptionParameters.

Methods in org.openhab.core.config.core with parameters of type ConfigDescriptionParameter

Modifier and Type	Method	Description
static @Nullable Object	ConfigUtil.getDefaultValueAsCorrectType(ConfigDescriptionParameter parameter)	Maps the provided (default) value of the given ConfigDescriptionParameter to the corresponding Java type.
static @Nullable Object	ConfigUtil.normalizeType(@Nullable Object value, @Nullable ConfigDescriptionParameter configDescriptionParameter)	Normalizes the type of the parameter to the one allowed for configurations.
ConfigDescriptionBuilder	ConfigDescriptionBuilder.withParameter(ConfigDescriptionParameter parameter)	Adds a ConfigDescriptionParameters.

Method parameters in org.openhab.core.config.core with type arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
ConfigDescriptionBuilder	ConfigDescriptionBuilder.withParameters(List<ConfigDescriptionParameter> parameters)	Adds a list of ConfigDescriptionParameters.

Uses of ConfigDescriptionParameter in org.openhab.core.config.core.dto

Methods in org.openhab.core.config.core.dto that return types with arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
static List<ConfigDescriptionParameter>	ConfigDescriptionDTOMapper.map(List<ConfigDescriptionParameterDTO> parameters)

Method parameters in org.openhab.core.config.core.dto with type arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
static List<ConfigDescriptionParameterDTO>	ConfigDescriptionDTOMapper.mapParameters(List<ConfigDescriptionParameter> parameters)	Maps configuration description parameters into DTO objects.

Uses of ConfigDescriptionParameter in org.openhab.core.config.core.i18n

Methods in org.openhab.core.config.core.i18n that return ConfigDescriptionParameter

Modifier and Type	Method	Description
ConfigDescriptionParameter	ConfigI18nLocalizationService.getLocalizedConfigDescriptionParameter(org.osgi.framework.Bundle bundle, URI configDescriptionURI, ConfigDescriptionParameter parameter, @Nullable Locale locale)	Localize a config description parameter.
ConfigDescriptionParameter	ConfigI18nLocalizationService.getLocalizedConfigDescriptionParameter(org.osgi.framework.Bundle bundle, ConfigDescription configDescription, ConfigDescriptionParameter parameter, @Nullable Locale locale)	Localize a config description parameter.

Methods in org.openhab.core.config.core.i18n with parameters of type ConfigDescriptionParameter

Modifier and Type	Method	Description
ConfigDescriptionParameter	ConfigI18nLocalizationService.getLocalizedConfigDescriptionParameter(org.osgi.framework.Bundle bundle, URI configDescriptionURI, ConfigDescriptionParameter parameter, @Nullable Locale locale)	Localize a config description parameter.
ConfigDescriptionParameter	ConfigI18nLocalizationService.getLocalizedConfigDescriptionParameter(org.osgi.framework.Bundle bundle, ConfigDescription configDescription, ConfigDescriptionParameter parameter, @Nullable Locale locale)	Localize a config description parameter.

Uses of ConfigDescriptionParameter in org.openhab.core.config.core.metadata

Methods in org.openhab.core.config.core.metadata that return types with arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
@Nullable List<ConfigDescriptionParameter>	MetadataConfigDescriptionProvider.getParameters(String value, @Nullable Locale locale)	Get the config descriptions for all expected parameters.

Uses of ConfigDescriptionParameter in org.openhab.core.io.rest.core.config

Method parameters in org.openhab.core.io.rest.core.config with type arguments of type ConfigDescriptionParameter

Modifier and Type	Method	Description
static List<EnrichedConfigDescriptionParameterDTO>	EnrichedConfigDescriptionDTOMapper.mapEnrichedParameters(List<ConfigDescriptionParameter> parameters)	Maps configuration description parameters into enriched DTO objects.