buzz.getcoco.iot

Class Rule

java.lang.Object

buzz.getcoco.iot.Rule

public class Rule
extends java.lang.Object

Rule class captures the rule defined by the user in a network, which when triggers upon certain conditions(ScheduleCondition) causes an action(ResourceAction) defined on the resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Rule.Condition An interface to be implemented by ScheduleCondition and ResourceCondition.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RULE_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rule(int id, Network parent)

Method Summary

Modifier and Type	Method and Description
int	getId()
java.lang.String	getName()
Network	getParent()
java.util.List<ResourceAction>	getResourceActions() This function fetches the resource actions set for this rule.
java.util.List<ResourceCondition>	getResourceConditions() A function to fetch resource conditions for this rule.
java.util.List<Scene>	getSceneActions() This function fetches the scene actions for this rule.
java.util.List<ScheduleCondition>	getScheduleConditions() This function fetches the schedule conditions set for this rule.
int	hashCode()
protected void	internalClearAddResourceActions(java.util.Collection<ResourceAction> resourceActions)
protected void	internalClearAddResourceConditions(java.util.Collection<ResourceCondition> resourceConditions)
protected void	internalClearAddSceneActions(java.util.Collection<Scene> scenesActions)
protected void	internalClearAddScheduleConditions(java.util.Collection<ScheduleCondition> scheduleConditions)
protected void	internalMarkAsReady()
protected void	internalSetName(java.lang.String name)
protected void	internalSetParent(Network parent)
boolean	isReady() A function suggesting if the rule is made from NativeCallbacks.ruleInfoCallback(boolean, java.lang.String, int, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[], java.lang.String[], java.lang.Object) or because of state retrieval.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_RULE_ID

public static final int DEFAULT_RULE_ID

See Also:

Constant Field Values

Constructor Detail

Rule

protected Rule(int id,
               Network parent)

Method Detail

getId

public int getId()

getName

public java.lang.String getName()

getParent

public Network getParent()

getResourceConditions

public java.util.List<ResourceCondition> getResourceConditions()

A function to fetch resource conditions for this rule.

Returns:

list of Resource conditions defined by user

getScheduleConditions

public java.util.List<ScheduleCondition> getScheduleConditions()

This function fetches the schedule conditions set for this rule.

Returns:

list of schedule conditions set for this rule

getResourceActions

public java.util.List<ResourceAction> getResourceActions()

This function fetches the resource actions set for this rule.

Returns:

list of resource actions set for this rule.

getSceneActions

public java.util.List<Scene> getSceneActions()

This function fetches the scene actions for this rule.

Returns:

list of scene actions defined by the user for this rule

isReady

public boolean isReady()

A function suggesting if the rule is made from NativeCallbacks.ruleInfoCallback(boolean, java.lang.String, int, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[], java.lang.String[], java.lang.Object) or because of state retrieval.

Returns:

boolean: state if the rule is dummy or not.

internalClearAddResourceConditions

protected void internalClearAddResourceConditions(java.util.Collection<ResourceCondition> resourceConditions)

internalClearAddScheduleConditions

protected void internalClearAddScheduleConditions(java.util.Collection<ScheduleCondition> scheduleConditions)

internalClearAddResourceActions

protected void internalClearAddResourceActions(java.util.Collection<ResourceAction> resourceActions)

internalClearAddSceneActions

protected void internalClearAddSceneActions(java.util.Collection<Scene> scenesActions)

internalSetName

protected void internalSetName(java.lang.String name)

internalSetParent

protected void internalSetParent(Network parent)

internalMarkAsReady

protected void internalMarkAsReady()

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object