Package org.openhab.core.automation.template

Interface Template

All Superinterfaces:
Identifiable<String>
All Known Implementing Classes:
RuleTemplate
@NonNullByDefault public interface Template extends Identifiable<String>
The templates define types of shared, ready to use definitions of automation objects, which can be instantiated and configured to produce automation instances. Each Template has a unique identifier (UID).

The Templates can be used by any creator of automation objects, but they can be modified only by its owner.

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

  • Method Details

    • getUID

      String getUID()
      Gets the unique identifier (UID) of a Template.
      Specified by:
      getUID in interface Identifiable<String>
      Returns:
      the identifier of the Template.

    • getTags

      Set<String> getTags()
      Gets the assigned tags to a Template. The templates can have tags - non-hierarchical keywords or terms for describing them. The tags are used to filter the templates.
      Returns:
      the tags assigned to the template.

    • getLabel

      @Nullable String getLabel()
      Gets the label of a Template. The label is a short, human-readable description of the Template defined by its creator.
      Returns:
      the label of the Template.

    • getDescription

      @Nullable String getDescription()
      Gets the description of a Template. The description is a detailed, human-understandable description of the purpose of a Template, defined by its creator.
      Returns:
      the description of the Template.

    • getVisibility

      Visibility getVisibility()
      Shows the visibility of a Template.
      Returns:
      the visibility of the Template.