Package org.openhab.core.automation.template

Class RuleTemplate

java.lang.Object

org.openhab.core.automation.template.RuleTemplate

All Implemented Interfaces:

Template, Identifiable<String>

@NonNullByDefault
public class RuleTemplate
extends Object
implements Template

This class is used to define Rule Templates which are shared combination of ready to use modules, which can be configured to produce Rule instances.

The RuleTemplates can be used by any creator of Rules, but they can be modified only by its creator. The template modification is done by updating the RuleTemplate.

Templates can have tags - non-hierarchical keywords or terms for describing them.

Author:

Yordan Mihaylov - Initial contribution, Ana Dimova - Initial contribution, Vasil Ilchev - Initial contribution, Markus Rathgeb - Add default constructor for deserialization

Constructor Summary

Constructors

Constructor	Description
RuleTemplate(@Nullable String uid, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable List<Trigger> triggers, @Nullable List<Condition> conditions, @Nullable List<Action> actions, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable Visibility visibility)	Creates a RuleTemplate instance that will be used for creating Rules from a set of modules, belong to the template.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)	Two objects are equal if they own equal UIDs.
List<Action>	getActions()	Gets the actions participating in RuleTemplate.
List<Condition>	getConditions()	Gets the conditions participating in RuleTemplate.
List<ConfigDescriptionParameter>	getConfigurationDescriptions()	Gets the List with ConfigDescriptionParameters defining meta info for configuration properties of the future Rule instances.
@Nullable String	getDescription()	Gets the human-readable description of the purpose of the RuleTemplate.
@Nullable String	getLabel()	Gets the RuleTemplate's human-readable label.
@Nullable Module	getModule(String moduleId)	Gets a Module participating in the RuleTemplate.
<T extends Module> List<T>	getModules(Class<T> moduleClazz)	Gets the modules of the RuleTemplate, corresponding to the specified class.
Set<String>	getTags()	Gets the RuleTemplate's assigned tags.
List<Trigger>	getTriggers()	Gets the triggers participating in RuleTemplate.
String	getUID()	Gets the unique identifier of the RuleTemplate.
Visibility	getVisibility()	Gets the RuleTemplate's Visibility.
int	hashCode()	Returns the hash code of this object depends on the hash code of the UID that it owns.

Methods inherited from class java.lang.Object

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

Constructor Details

RuleTemplate

public RuleTemplate(@Nullable String uid,
 @Nullable String label,
 @Nullable String description,
 @Nullable Set<String> tags,
 @Nullable List<Trigger> triggers,
 @Nullable List<Condition> conditions,
 @Nullable List<Action> actions,
 @Nullable List<ConfigDescriptionParameter> configDescriptions,
 @Nullable Visibility visibility)

Creates a RuleTemplate instance that will be used for creating Rules from a set of modules, belong to the template. When null is passed for the uid parameter, the RuleTemplate's identifier will be randomly generated.

Parameters:

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

label - the short human-readable RuleTemplate's label.

description - a detailed human-readable RuleTemplate's description.

tags - the RuleTemplate's assigned tags.

triggers - the RuleTemplate's triggers list, or null if the RuleTemplate should have no triggers.

conditions - the RuleTemplate's conditions list, or null if the RuleTemplate should have no conditions.

actions - the RuleTemplate's actions list, or null if the RuleTemplate should have no actions.

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

visibility - the RuleTemplate's visibility.

Method Details

getUID

public String getUID()

Gets the unique identifier of the RuleTemplate. It can be specified by the RuleTemplate's creator, or randomly generated.

Specified by:

getUID in interface Identifiable<String>

Specified by:

getUID in interface Template

Returns:

an identifier of this RuleTemplate. Can't be null.

getTags

public Set<String> getTags()

Gets the RuleTemplate's assigned tags.

Specified by:

getTags in interface Template

Returns:

the RuleTemplate's assigned tags.

getLabel

public @Nullable String getLabel()

Gets the RuleTemplate's human-readable label.

Specified by:

getLabel in interface Template

Returns:

the RuleTemplate's human-readable label, or null if not specified.

getDescription

public @Nullable String getDescription()

Gets the human-readable description of the purpose of the RuleTemplate.

Specified by:

getDescription in interface Template

Returns:

the RuleTemplate's human-readable description, or null.

getVisibility

public Visibility getVisibility()

Gets the RuleTemplate's Visibility.

Specified by:

getVisibility in interface Template

Returns:

the RuleTemplate's Visibility value.

getConfigurationDescriptions

public List<ConfigDescriptionParameter> getConfigurationDescriptions()

Gets the List with ConfigDescriptionParameters defining meta info for configuration properties of the future Rule instances.

Returns:

a List of ConfigDescriptionParameters.

getModule

public @Nullable Module getModule(String moduleId)

Gets a Module participating in the RuleTemplate.

Parameters:

moduleId - unique identifier of a module in this RuleTemplate.

Returns:

module with specified identifier or null when such does not exist.

getModules

public <T extends Module> List<T> getModules(Class<T> moduleClazz)

Gets the modules of the RuleTemplate, corresponding to the specified class.

Parameters:

moduleClazz - defines the class of the looking modules. It can be Module, Trigger, Condition or Action.

Returns:

the modules of defined type or empty list if the RuleTemplate has no modules that belong to the specified type.

getTriggers

public List<Trigger> getTriggers()

Gets the triggers participating in RuleTemplate.

Returns:

a list with the triggers that belong to this RuleTemplate.

getConditions

public List<Condition> getConditions()

Gets the conditions participating in RuleTemplate.

Returns:

a list with the conditions that belong to this RuleTemplate.

getActions

public List<Action> getActions()

Gets the actions participating in RuleTemplate.

Returns:

a list with the actions that belong to this RuleTemplate.

hashCode

public int hashCode()

Returns the hash code of this object depends on the hash code of the UID that it owns.

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Two objects are equal if they own equal UIDs.

Overrides:

equals in class Object