Uses of Interface
org.openhab.core.automation.Rule

Packages that use Rule

Package	Description
org.openhab.core.automation
org.openhab.core.automation.converter
org.openhab.core.automation.dto
org.openhab.core.automation.module.script.rulesupport.shared
org.openhab.core.automation.module.script.rulesupport.shared.simple
org.openhab.core.automation.util
org.openhab.core.model.script.lib

Uses of Rule in org.openhab.core.automation

Methods in org.openhab.core.automation that return Rule

Modifier and Type	Method	Description
Rule	RuleRegistry.add(Rule rule)	This method is used to register a Rule into the RuleRegistry.
Rule	RuleExecution.getRule()	Returns the rule that will be executed.
protected @Nullable Rule	ManagedRuleProvider.toElement(String key, RuleDTO persistableElement)

Methods in org.openhab.core.automation that return types with arguments of type Rule

Modifier and Type	Method	Description
Collection<Rule>	RuleRegistry.getByTag(@Nullable String tag)	Gets a collection of Rules which shares same tag.
Collection<Rule>	RuleRegistry.getByTags(String... tags)	Gets a collection of Rules which has specified tags.
static Predicate<Rule>	RulePredicates.hasAllTags(String @Nullable ... tags)	Creates a Predicate which can be used to match Rules for all given tags or no tags at all.
static Predicate<Rule>	RulePredicates.hasAllTags(@Nullable Collection<String> tags)	Creates a Predicate which can be used to match Rules with all given tags or no tags at all.
static Predicate<Rule>	RulePredicates.hasAnyOfPrefixes(String... prefixes)	Creates a Predicate which can be used to match Rules for any of the given prefixes and even null prefix.
static Predicate<Rule>	RulePredicates.hasAnyOfTags(String @Nullable ... tags)	Creates a Predicate which can be used to match Rules for any of the given tags or Rules without tags.
static Predicate<Rule>	RulePredicates.hasAnyOfTags(@Nullable Collection<String> tags)	Creates a Predicate which can be used to match Rules for any of the given tags or Rules without tags.
static Predicate<Rule>	RulePredicates.hasNoTags()	Creates a Predicate which can be used to match Rules without tags.
static Predicate<Rule>	RulePredicates.hasPrefix(@Nullable String prefix)	Creates a Predicate which can be used to filter Rules for a given prefix or null prefix.
static Predicate<Rule>	RulePredicates.hasTags()	Creates a Predicate which can be used to match Rules with one or more tags.

Methods in org.openhab.core.automation with parameters of type Rule

Modifier and Type	Method	Description
Rule	RuleRegistry.add(Rule rule)	This method is used to register a Rule into the RuleRegistry.
static @Nullable String	RulePredicates.getPrefix(@Nullable Rule rule)	Gets the prefix of the Rule's UID, if any exist.
protected RuleDTO	ManagedRuleProvider.toPersistableElement(Rule element)

Constructors in org.openhab.core.automation with parameters of type Rule

Modifier	Constructor	Description
	RuleExecution(Date date, Rule rule)	Creates a new RuleExecution.

Uses of Rule in org.openhab.core.automation.converter

Methods in org.openhab.core.automation.converter that return types with arguments of type Rule

Modifier and Type	Method	Description
Collection<Rule>	RuleParser.getParsedObjects(String modelName)	Get the Rule objects found when parsing the format.

Method parameters in org.openhab.core.automation.converter with type arguments of type Rule

Modifier and Type	Method	Description
List<SerializabilityResult<String>>	RuleSerializer.checkSerializability(Collection<Rule> rules)	Checks if the specified rules are serializable with this RuleSerializer.
void	RuleSerializer.setRulesToBeSerialized(String id, List<Rule> rules, RuleSerializer.RuleSerializationOption option)	Specify the List of Rules to be serialized and associate them with an identifier.

Uses of Rule in org.openhab.core.automation.dto

Methods in org.openhab.core.automation.dto that return Rule

Modifier and Type	Method	Description
static Rule	RuleDTOMapper.map(RuleDTO ruleDto)

Methods in org.openhab.core.automation.dto with parameters of type Rule

Modifier and Type	Method	Description
protected static void	RuleDTOMapper.fillProperties(Rule from, RuleDTO to)
static RuleDTO	RuleDTOMapper.map(Rule rule)

Uses of Rule in org.openhab.core.automation.module.script.rulesupport.shared

Methods in org.openhab.core.automation.module.script.rulesupport.shared that return Rule

Modifier and Type	Method	Description
Rule	RuleSupportRuleRegistryDelegate.add(Rule element)
Rule	ScriptedAutomationManager.addRule(Rule element)
Rule	ScriptedAutomationManager.addUnmanagedRule(Rule element)
@Nullable Rule	RuleSupportRuleRegistryDelegate.get(String key)
@Nullable Rule	ScriptedRuleProvider.get(String ruleUID)
@Nullable Rule	RuleSupportRuleRegistryDelegate.remove(String key)
@Nullable Rule	ScriptedRuleProvider.remove(String ruleUID)
@Nullable Rule	RuleSupportRuleRegistryDelegate.update(Rule element)
@Nullable Rule	ScriptedRuleProvider.update(Rule rule)

Methods in org.openhab.core.automation.module.script.rulesupport.shared that return types with arguments of type Rule

Modifier and Type	Method	Description
Collection<Rule>	RuleSupportRuleRegistryDelegate.getAll()
Collection<Rule>	ScriptedRuleProvider.getAll()
Collection<Rule>	RuleSupportRuleRegistryDelegate.getByTag(@Nullable String tag)
Collection<Rule>	RuleSupportRuleRegistryDelegate.getByTags(String... tags)
Stream<Rule>	RuleSupportRuleRegistryDelegate.stream()

Methods in org.openhab.core.automation.module.script.rulesupport.shared with parameters of type Rule

Modifier and Type	Method	Description
Rule	RuleSupportRuleRegistryDelegate.add(Rule element)
void	ScriptedRuleProvider.add(Rule rule)
void	RuleSupportRuleRegistryDelegate.addPermanent(Rule element)	add a rule permanently to the RuleManager
Rule	ScriptedAutomationManager.addRule(Rule element)
void	ScriptedRuleProvider.addRule(Rule rule)	Deprecated.
Rule	ScriptedAutomationManager.addUnmanagedRule(Rule element)
void	ScriptedRuleProvider.removeRule(Rule rule)
@Nullable Rule	RuleSupportRuleRegistryDelegate.update(Rule element)
@Nullable Rule	ScriptedRuleProvider.update(Rule rule)

Method parameters in org.openhab.core.automation.module.script.rulesupport.shared with type arguments of type Rule

Modifier and Type	Method	Description
void	RuleSupportRuleRegistryDelegate.addRegistryChangeListener(RegistryChangeListener<Rule> listener)
void	RuleSupportRuleRegistryDelegate.removeRegistryChangeListener(RegistryChangeListener<Rule> listener)

Uses of Rule in org.openhab.core.automation.module.script.rulesupport.shared.simple

Classes in org.openhab.core.automation.module.script.rulesupport.shared.simple that implement Rule

Modifier and Type	Class	Description
class	SimpleRule	Convenience Rule implementation with a SimpleRuleActionHandler.

Uses of Rule in org.openhab.core.automation.util

Methods in org.openhab.core.automation.util that return Rule

Modifier and Type	Method	Description
Rule	RuleBuilder.build()

Methods in org.openhab.core.automation.util with parameters of type Rule

Modifier and Type	Method	Description
static RuleBuilder	RuleBuilder.create(String ruleUid, Rule r)	Build a new Rule with a new UID, based on an existing rule.
static RuleBuilder	RuleBuilder.create(Rule r)	Build a new Rule based on an existing rule.

Constructors in org.openhab.core.automation.util with parameters of type Rule

Modifier	Constructor	Description
protected	RuleBuilder(Rule rule)

Uses of Rule in org.openhab.core.model.script.lib

Methods in org.openhab.core.model.script.lib that return Rule

Modifier and Type	Method	Description
static @Nullable Rule	Rules.getRule(String ruleUid)	Get a rule by UID.

Methods in org.openhab.core.model.script.lib with parameters of type Rule

Modifier and Type	Method	Description
static boolean	RuleExtensions.isEnabled(Rule rule)	Check whether the specified rule is enabled.
static Map<String,@Nullable Object>	RuleExtensions.run(Rule rule)	Run the specified rule.
static Map<String,@Nullable Object>	RuleExtensions.run(Rule rule, boolean considerConditions)	Run the specified rule while optionally taking conditions into account.
static Map<String,@Nullable Object>	RuleExtensions.run(Rule rule, boolean considerConditions, Object... context)	Run the specified rule with the specified context, while optionally taking conditions into account.
static Map<String,@Nullable Object>	RuleExtensions.run(Rule rule, boolean considerConditions, @Nullable Map<String,@Nullable Object> context)	Run the specified rule with the specified context, while optionally taking conditions into account.
static Map<String,@Nullable Object>	RuleExtensions.run(Rule rule, Map<String,@Nullable Object> context)	Run the specified rule with the specified context.
static void	RuleExtensions.setEnabled(Rule rule, boolean enabled)	Set whether the specified rule is enabled.