Package org.openremote.model.rules.json

Enum Class RuleRecurrence.Scope

java.lang.Object

java.lang.Enum<RuleRecurrence.Scope>

org.openremote.model.rules.json.RuleRecurrence.Scope

All Implemented Interfaces:

Serializable, Comparable<RuleRecurrence.Scope>, Constable

Enclosing class:

RuleRecurrence

public static enum RuleRecurrence.Scope
extends Enum<RuleRecurrence.Scope>

Defines the scope of the recurrence

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GLOBAL	Recurrence applies globally (i.e.
PER_ASSET	Recurrence applies to each asset individually (i.e.

Method Summary

Modifier and Type	Method	Description
static RuleRecurrence.Scope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RuleRecurrence.Scope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PER_ASSET

public static final RuleRecurrence.Scope PER_ASSET

Recurrence applies to each asset individually (i.e. timer starts from when rule triggered, each asset that triggered the rule will have their own timer based on RuleRecurrence.mins value)

GLOBAL

public static final RuleRecurrence.Scope GLOBAL

Recurrence applies globally (i.e. timer starts from when rule triggered, there is a single timer based on RuleRecurrence.mins value, this rule will not fire again until timer expires)

Method Details

values

public static RuleRecurrence.Scope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RuleRecurrence.Scope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null