Package org.openhab.core.config.core.dto

Class ConfigDescriptionParameterDTO

java.lang.Object

org.openhab.core.config.core.dto.ConfigDescriptionParameterDTO

Direct Known Subclasses:

EnrichedConfigDescriptionParameterDTO

public class ConfigDescriptionParameterDTO
extends Object

This is a data transfer object that is used to serialize parameter of a configuration description.

Author:

Dennis Nobel - Initial contribution, Alex Tugarev - Extended for options and filter criteria, Chris Jackson - Added group, advanced, limitToOptions, multipleLimit, verify attributes, Thomas Höfer - Added unit

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	advanced
String	context
String	defaultValue
String	description
List<FilterCriteriaDTO>	filterCriteria
String	groupName
String	label
Boolean	limitToOptions
BigDecimal	max
BigDecimal	min
Boolean	multiple
Integer	multipleLimit
String	name
List<ParameterOptionDTO>	options
String	pattern
Boolean	readOnly
boolean	required
BigDecimal	stepsize
ConfigDescriptionParameter.Type	type
String	unit
String	unitLabel
Boolean	verify

Constructor Summary

Constructors

Constructor	Description
ConfigDescriptionParameterDTO()
ConfigDescriptionParameterDTO(String name, ConfigDescriptionParameter.Type type, BigDecimal minimum, BigDecimal maximum, BigDecimal stepsize, String pattern, Boolean required, Boolean readOnly, Boolean multiple, String context, String defaultValue, String label, String description, List<ParameterOptionDTO> options, List<FilterCriteriaDTO> filterCriteria, String groupName, Boolean advanced, Boolean limitToOptions, Integer multipleLimit, String unit, String unitLabel, Boolean verify)

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

context

public String context

defaultValue

@SerializedName(value="default",
                alternate="defaultValue")
public String defaultValue

description

public String description

label

public String label

name

public String name

required

public boolean required

type

public ConfigDescriptionParameter.Type type

min

public BigDecimal min

max

public BigDecimal max

stepsize

public BigDecimal stepsize

pattern

public String pattern

readOnly

public Boolean readOnly

multiple

public Boolean multiple

multipleLimit

public Integer multipleLimit

groupName

public String groupName

advanced

public Boolean advanced

verify

public Boolean verify

limitToOptions

public Boolean limitToOptions

unit

public String unit

unitLabel

public String unitLabel

options

public List<ParameterOptionDTO> options

filterCriteria

public List<FilterCriteriaDTO> filterCriteria

Constructor Details

ConfigDescriptionParameterDTO

public ConfigDescriptionParameterDTO()

ConfigDescriptionParameterDTO

public ConfigDescriptionParameterDTO(String name,
 ConfigDescriptionParameter.Type type,
 BigDecimal minimum,
 BigDecimal maximum,
 BigDecimal stepsize,
 String pattern,
 Boolean required,
 Boolean readOnly,
 Boolean multiple,
 String context,
 String defaultValue,
 String label,
 String description,
 List<ParameterOptionDTO> options,
 List<FilterCriteriaDTO> filterCriteria,
 String groupName,
 Boolean advanced,
 Boolean limitToOptions,
 Integer multipleLimit,
 String unit,
 String unitLabel,
 Boolean verify)