Package org.openhab.core.sitemap

Interface Rule

@NonNullByDefault public interface Rule
A representation of a sitemap widget icon, color or visibility rule.
Author:
Mark Herwege - Initial contribution

  • Method Summary

    Modifier and Type
    Method
    Description
    List<Condition>
    getConditions()
    Get the rule conditions.
    @Nullable String
    getValue()
    Get the rule value for icon, color or confirmCmd rules.
    void
    setConditions(List<Condition> conditions)
    Replace the rule conditions with a new list of conditions.
    void
    setValue(@Nullable String value)
    Set the rule value.

  • Method Details

    • getConditions

      List<Condition> getConditions()
      Get the rule conditions. This method should return a modifiable list, allowing updates to conditions.
      Returns:
      conditions

    • setConditions

      void setConditions(List<Condition> conditions)
      Replace the rule conditions with a new list of conditions.
      Parameters:
      conditions -

    • getValue

      @Nullable String getValue()
      Get the rule value for icon, color or confirmCmd rules. The rule value is the resulting value if the rule is met. Visibility rules don't have a value, always work on the full widget.
      Returns:
      value

    • setValue

      void setValue(@Nullable String value)
      Set the rule value.
      Parameters:
      value -