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

Class XmlParameter

java.lang.Object

org.openhab.core.config.core.dto.XmlParameter

All Implemented Interfaces:

Serializable

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public class XmlParameter
extends Object
implements Serializable

Java class for parameter complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="parameter">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="context" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="required" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="default" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="label" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="options" type="{https://openhab.org/schemas/config-description/v1.0.0}optionsType" minOccurs="0"/>
         <element name="limitToOptions" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="filter" type="{https://openhab.org/schemas/config-description/v1.0.0}filterType" minOccurs="0"/>
         <element name="advanced" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="verify" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="multipleLimit" type="{http://www.w3.org/2001/XMLSchema}integer" minOccurs="0"/>
         <element name="unitLabel" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </all>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="type" use="required" type="{https://openhab.org/schemas/config-description/v1.0.0}parameterType" />
       <attribute name="groupName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="min" type="{http://www.w3.org/2001/XMLSchema}decimal" />
       <attribute name="max" type="{http://www.w3.org/2001/XMLSchema}decimal" />
       <attribute name="step" type="{http://www.w3.org/2001/XMLSchema}decimal" />
       <attribute name="pattern" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="readOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="multiple" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="unit" type="{https://openhab.org/schemas/config-description/v1.0.0}unitType" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_default
protected Boolean	advanced
protected String	context
protected String	description
protected List<XmlCriteria>	filter
protected String	groupName
protected String	label
protected Boolean	limitToOptions
protected BigDecimal	max
protected BigDecimal	min
protected Boolean	multiple
protected BigInteger	multipleLimit
protected String	name
protected List<XmlOption>	options
protected String	pattern
protected Boolean	readOnly
protected Boolean	required
protected Boolean	requiredAttribute
protected BigDecimal	step
protected XmlParameterType	type
protected String	unit
protected String	unitLabel
protected Boolean	verify

Constructor Summary

Constructors

Constructor	Description
XmlParameter()

Method Summary

Modifier and Type	Method	Description
String	getContext()	Gets the value of the context property.
String	getDefault()	Gets the value of the default property.
String	getDescription()	Gets the value of the description property.
List<XmlCriteria>	getFilter()
String	getGroupName()	Gets the value of the groupName property.
String	getLabel()	Gets the value of the label property.
BigDecimal	getMax()	Gets the value of the max property.
BigDecimal	getMin()	Gets the value of the min property.
BigInteger	getMultipleLimit()	Gets the value of the multipleLimit property.
String	getName()	Gets the value of the name property.
List<XmlOption>	getOptions()
String	getPattern()	Gets the value of the pattern property.
BigDecimal	getStep()	Gets the value of the step property.
XmlParameterType	getType()	Gets the value of the type property.
String	getUnit()	Gets the value of the unit property.
String	getUnitLabel()	Gets the value of the unitLabel property.
Boolean	isAdvanced()	Gets the value of the advanced property.
Boolean	isLimitToOptions()	Gets the value of the limitToOptions property.
Boolean	isMultiple()	Gets the value of the multiple property.
Boolean	isReadOnly()	Gets the value of the readOnly property.
Boolean	isRequired()	Gets the value of the required property.
Boolean	isRequiredAttribute()	Gets the value of the requiredAttribute property.
Boolean	isVerify()	Gets the value of the verify property.
void	setAdvanced(Boolean value)	Sets the value of the advanced property.
void	setContext(String value)	Sets the value of the context property.
void	setDefault(String value)	Sets the value of the default property.
void	setDescription(String value)	Sets the value of the description property.
void	setFilter(List<XmlCriteria> filter)
void	setGroupName(String value)	Sets the value of the groupName property.
void	setLabel(String value)	Sets the value of the label property.
void	setLimitToOptions(Boolean value)	Sets the value of the limitToOptions property.
void	setMax(BigDecimal value)	Sets the value of the max property.
void	setMin(BigDecimal value)	Sets the value of the min property.
void	setMultiple(Boolean value)	Sets the value of the multiple property.
void	setMultipleLimit(BigInteger value)	Sets the value of the multipleLimit property.
void	setName(String value)	Sets the value of the name property.
void	setOptions(List<XmlOption> options)
void	setPattern(String value)	Sets the value of the pattern property.
void	setReadOnly(Boolean value)	Sets the value of the readOnly property.
void	setRequired(Boolean value)	Sets the value of the required property.
void	setRequiredAttribute(Boolean value)	Sets the value of the requiredAttribute property.
void	setStep(BigDecimal value)	Sets the value of the step property.
void	setType(XmlParameterType value)	Sets the value of the type property.
void	setUnit(String value)	Sets the value of the unit property.
void	setUnitLabel(String value)	Sets the value of the unitLabel property.
void	setVerify(Boolean value)	Sets the value of the verify property.

Methods inherited from class java.lang.Object

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

Field Details

context

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String context

required

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected Boolean required

_default

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String _default

label

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String label

description

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String description

options

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected List<XmlOption> options

limitToOptions

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected Boolean limitToOptions

filter

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected List<XmlCriteria> filter

advanced

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected Boolean advanced

verify

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected Boolean verify

multipleLimit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected BigInteger multipleLimit

unitLabel

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String unitLabel

name

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String name

type

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected XmlParameterType type

groupName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String groupName

min

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected BigDecimal min

max

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected BigDecimal max

step

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected BigDecimal step

pattern

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String pattern

requiredAttribute

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected Boolean requiredAttribute

readOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected Boolean readOnly

multiple

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected Boolean multiple

unit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
protected String unit

Constructor Details

XmlParameter

public XmlParameter()

Method Details

getContext

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getContext()

Gets the value of the context property.

Returns:

possible object is String

setContext

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setContext(String value)

Sets the value of the context property.

Parameters:

value - allowed object is String

isRequired

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public Boolean isRequired()

Gets the value of the required property.

Returns:

possible object is Boolean

setRequired

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setRequired(Boolean value)

Sets the value of the required property.

Parameters:

value - allowed object is Boolean

getDefault

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getDefault()

Gets the value of the default property.

Returns:

possible object is String

setDefault

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setDefault(String value)

Sets the value of the default property.

Parameters:

value - allowed object is String

getLabel

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getLabel()

Gets the value of the label property.

Returns:

possible object is String

setLabel

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setLabel(String value)

Sets the value of the label property.

Parameters:

value - allowed object is String

getDescription

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

isLimitToOptions

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public Boolean isLimitToOptions()

Gets the value of the limitToOptions property.

Returns:

possible object is Boolean

setLimitToOptions

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setLimitToOptions(Boolean value)

Sets the value of the limitToOptions property.

Parameters:

value - allowed object is Boolean

isAdvanced

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public Boolean isAdvanced()

Gets the value of the advanced property.

Returns:

possible object is Boolean

setAdvanced

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setAdvanced(Boolean value)

Sets the value of the advanced property.

Parameters:

value - allowed object is Boolean

isVerify

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public Boolean isVerify()

Gets the value of the verify property.

Returns:

possible object is Boolean

setVerify

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setVerify(Boolean value)

Sets the value of the verify property.

Parameters:

value - allowed object is Boolean

getMultipleLimit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public BigInteger getMultipleLimit()

Gets the value of the multipleLimit property.

Returns:

possible object is BigInteger

setMultipleLimit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setMultipleLimit(BigInteger value)

Sets the value of the multipleLimit property.

Parameters:

value - allowed object is BigInteger

getUnitLabel

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getUnitLabel()

Gets the value of the unitLabel property.

Returns:

possible object is String

setUnitLabel

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setUnitLabel(String value)

Sets the value of the unitLabel property.

Parameters:

value - allowed object is String

getName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public XmlParameterType getType()

Gets the value of the type property.

Returns:

possible object is XmlParameterType

setType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setType(XmlParameterType value)

Sets the value of the type property.

Parameters:

value - allowed object is XmlParameterType

getGroupName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getGroupName()

Gets the value of the groupName property.

Returns:

possible object is String

setGroupName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setGroupName(String value)

Sets the value of the groupName property.

Parameters:

value - allowed object is String

getMin

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public BigDecimal getMin()

Gets the value of the min property.

Returns:

possible object is BigDecimal

setMin

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setMin(BigDecimal value)

Sets the value of the min property.

Parameters:

value - allowed object is BigDecimal

getMax

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public BigDecimal getMax()

Gets the value of the max property.

Returns:

possible object is BigDecimal

setMax

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setMax(BigDecimal value)

Sets the value of the max property.

Parameters:

value - allowed object is BigDecimal

getStep

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public BigDecimal getStep()

Gets the value of the step property.

Returns:

possible object is BigDecimal

setStep

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setStep(BigDecimal value)

Sets the value of the step property.

Parameters:

value - allowed object is BigDecimal

getPattern

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getPattern()

Gets the value of the pattern property.

Returns:

possible object is String

setPattern

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setPattern(String value)

Sets the value of the pattern property.

Parameters:

value - allowed object is String

isRequiredAttribute

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public Boolean isRequiredAttribute()

Gets the value of the requiredAttribute property.

Returns:

possible object is Boolean

setRequiredAttribute

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setRequiredAttribute(Boolean value)

Sets the value of the requiredAttribute property.

Parameters:

value - allowed object is Boolean

isReadOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public Boolean isReadOnly()

Gets the value of the readOnly property.

Returns:

possible object is Boolean

setReadOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setReadOnly(Boolean value)

Sets the value of the readOnly property.

Parameters:

value - allowed object is Boolean

isMultiple

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public Boolean isMultiple()

Gets the value of the multiple property.

Returns:

possible object is Boolean

setMultiple

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setMultiple(Boolean value)

Sets the value of the multiple property.

Parameters:

value - allowed object is Boolean

getUnit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public String getUnit()

Gets the value of the unit property.

Returns:

possible object is String

setUnit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setUnit(String value)

Sets the value of the unit property.

Parameters:

value - allowed object is String

getOptions

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public List<XmlOption> getOptions()

setOptions

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setOptions(List<XmlOption> options)

getFilter

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public List<XmlCriteria> getFilter()

setFilter

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v2.3.7",
           date="2024-10-06T04:03:06Z")
public void setFilter(List<XmlCriteria> filter)