Package org.openhab.core.automation.type

Class CompositeActionType

java.lang.Object

org.openhab.core.automation.type.ModuleType

org.openhab.core.automation.type.ActionType

org.openhab.core.automation.type.CompositeActionType

All Implemented Interfaces:

Identifiable<String>

@NonNullByDefault
public class CompositeActionType
extends ActionType

This class is as ActionType which logically combines Action instances. The composite action hides internal logic and inner connections between participating Actions and it can be used as a regular Action 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
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.

Method Summary

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

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

getInputs, 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

CompositeActionType

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

Parameters:

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

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

inputs - a List with Input meta-information descriptions of the future Action instances.

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

children - is a List of Actions.

CompositeActionType

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

Parameters:

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

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

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

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

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

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

inputs - a List with Input meta-information descriptions of the future Action instances.

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

children - is a List of Actions.

Method Details

getChildren

public List<Action> getChildren()

Gets the Action modules of the CompositeActionType.

Returns:

a List of the Action modules of this CompositeActionType.