Package org.openhab.core.automation.type

Class CompositeConditionType

java.lang.Object

org.openhab.core.automation.type.ModuleType

org.openhab.core.automation.type.ConditionType

org.openhab.core.automation.type.CompositeConditionType

All Implemented Interfaces:

Identifiable<String>

@NonNullByDefault
public class CompositeConditionType
extends ConditionType

This class is as ConditionType which logically combines Condition modules. The composite condition hides internal logic between participating conditions and it can be used as a regular Condition module.

Author:

Yordan Mihaylov - Initial contribution, Ana Dimova - Initial contribution, Vasil Ilchev - Initial contribution

Field Summary

Fields inherited from class org.openhab.core.automation.type.ModuleType

configDescriptions

Constructor Summary

Constructors

Constructor	Description
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.

Method Summary

Modifier and Type	Method	Description
List<Condition>	getChildren()	Gets the Condition modules of the CompositeConditionType.

Methods inherited from class org.openhab.core.automation.type.ConditionType

getInputs

Methods inherited from class org.openhab.core.automation.type.ModuleType

equals, getConfigurationDescriptions, getDescription, getLabel, getTags, getUID, getVisibility, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

CompositeConditionType

public 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. It initializes only base properties of the CompositeConditionType.

Parameters:

uid - is the ConditionType's identifier, or null if a random identifier should be generated.

configDescriptions - is a List of configuration descriptions describing meta-data for the configuration of the future Condition instances.

inputs - is a List with Input's meta-information descriptions of the future Condition instances.

children - is a List of Conditions.

CompositeConditionType

public 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. It initializes all properties of the CompositeConditionType.

Parameters:

uid - is the ConditionType's identifier, or null if a random identifier should be generated.

configDescriptions - is a List of configuration descriptions describing meta-data for the configuration of the future Condition instances.

label - a short and accurate, human-readable label of the CompositeConditionType.

description - a detailed, human-readable description of usage of CompositeConditionType and its benefits.

tags - defines categories that fit the CompositeConditionType and which can serve as criteria for searching or filtering it.

visibility - determines whether the CompositeConditionType can be used by anyone if it is Visibility.VISIBLE or only by its creator if it is Visibility.HIDDEN. If null is provided the default visibility Visibility.VISIBLE will be used.

inputs - is a List with Input's meta-information descriptions of the future Condition instances.

children - is a List of Conditions.

Method Details

getChildren

public List<Condition> getChildren()

Gets the Condition modules of the CompositeConditionType.

Returns:

a List of the Condition modules of this CompositeConditionType.