Package org.openhab.core.automation.type

Class CompositeTriggerType

java.lang.Object

org.openhab.core.automation.type.ModuleType

org.openhab.core.automation.type.TriggerType

org.openhab.core.automation.type.CompositeTriggerType

All Implemented Interfaces:

Identifiable<String>

@NonNullByDefault
public class CompositeTriggerType
extends TriggerType

This class is as TriggerType which logically combines Trigger modules. The composite trigger hides internal logic between participating Triggers and it can be used as a regular Trigger 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
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.

Method Summary

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

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

getOutputs

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

CompositeTriggerType

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

Parameters:

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

configDescriptions - describing meta-data for the configuration of the future Trigger instances.

outputs - a List with Output meta-information descriptions of the future Trigger instances.

children - is a List of Trigger modules.

CompositeTriggerType

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

Parameters:

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

configDescriptions - describing meta-data for the configuration of the future Trigger instances.

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

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

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

visibility - determines whether the TriggerType can be used by anyone if it is Visibility.VISIBLE or only by its creator if it is Visibility.HIDDEN.

outputs - a List with Output meta-information descriptions of the future Trigger instances.

children - is a List of Trigger modules.

Method Details

getChildren

public List<Trigger> getChildren()

Gets the Trigger modules of the CompositeTriggerType.

Returns:

a List of the Trigger modules of this CompositeTriggerType.