Rule (cococlientsdk-java 0.28.2 API)

java.lang.Object
- buzz.getcoco.iot.Rule

public class Rule
extends java.lang.Object

Rule can be considered as a tools that allows user to trigger actions of his/her choice when defined constraints are met.

   Like:
   If (it's too dim) then (turn on lights).

   If
   (CapabilityIlluminance.AttributeId.CURRENT_LUMINANCE_LUX < 60)
   then
   Capability.sendResourceCommand(Command, Capability.CommandStatusListener)
   with args:
   new CapabilityOnOff.On()

   The above can be automated using a rule, and is shown below.

Rule class acts as a blueprint for a rule in a network. A network can have multiple rules. Rules can be added using Network.createRule(String, Network.NetworkManagementStatusListener), deleted using Network.deleteRule(Rule, Network.NetworkManagementStatusListener), modified using Network.SaveRule by user.

   There exists two types of constraints :
      Time based constraints ScheduleCondition
      Event based constraints ResourceCondition

   Action can exist in two forms:
      Action that directly act on Resources called ResourceAction
      Action that execute scenes,which in turn might have one or more
      ResourceAction Scene.getResourceActionMap()

   
     Network.SaveRule saveRule = new Network.SaveRule();

     saveRule.id = rule.getId();
     saveRule.name = rule.getName();

     saveRule.resourceActions = Arrays.asList(
         new ResourceAction(capabilityOnOff, onCommand)
     );

     saveRule.sceneActions = Arrays.asList(
         goodMorningScene,
         sundayScene
     );

     saveRule.resourceConditions = Arrays.asList(
         new ResourceCondition(
             illuminanceSensor,
             CapabilityIlluminance.AttributeId.CURRENT_LUMINANCE_LUX,
             ResourceCondition.OperatorType.GREATER_THAN,
             10_000, // condition is true for more than 10 seconds
             null, // ok as long as correctConditionsDataTypes is triggered.
             500 // 500 lux
         )
     );

     saveRule.scheduleConditions = Arrays.asList(
         new ScheduleCondition.Builder()
             .setStartTime(Instant.parse("2021-01-02T10:15:00.00Z"))
             .setExpiryTime(LocalTime.of(11, 59))
             .setScheduleType(ScheduleCondition.ScheduleType.WEEKLY)
             .build()
     );

     saveRule.correctConditionsDataTypes();

     network.sendNetworkManagementCommand(saveRule, (status, tr) -> {
       // handle status
     });

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Rule.Condition
An interface to be implemented by ScheduleCondition and ResourceCondition.

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
Default ID of a rule.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_RULE_ID` Default ID of a rule.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Rule(int id, Network parent)
Constructs a rule with given ID and parent.

Constructors
Modifier	Constructor and Description
`protected`	`Rule(int id, Network parent)` Constructs a rule with given ID and parent.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getId()` This function is used to get ID of the scene.
`java.lang.String`	`getName()` This function is used to get Name of the Scene.
`Network`	`getParent()` This function is used to get network that this scene belongs to.
`java.util.List<ResourceAction>`	`getResourceActions()` This function fetches the resource actions 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)` A function that would be triggered when `resourceActions` of the rule is updated.
`protected void`	`internalClearAddResourceConditions(java.util.Collection<ResourceCondition> resourceConditions)` A function that would be triggered when `resourceConditions` is updated.
`protected void`	`internalClearAddSceneActions(java.util.Collection<Scene> scenesActions)` A function that would be triggered when `sceneActions` of the rule is updated.
`protected void`	`internalClearAddScheduleConditions(java.util.Collection<ScheduleCondition> scheduleConditions)` A function that would be triggered when `scheduleConditions` is updated.
`protected void`	`internalMarkAsReady()` A function that will be triggered to mark this rule as ready.
`protected void`	`internalSetName(java.lang.String name)` A function that would be triggered when `name` is updated.
`protected void`	`internalSetParent(Network parent)` A function that would be triggered when parent network is updated.
`boolean`	`isReady()` A function suggesting if the rule is created 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 retrieved from cache.
`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
```
    Default ID of a rule.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Rule
```
protected Rule(int id,
               Network parent)
```
    Constructs a rule with given ID and parent.
    
    Parameters:
    
    id - ID of rule.
    
    parent - parent of the rule.
- Method Detail
  - getId
```
public int getId()
```
    This function is used to get ID of the scene.
    
    Returns:
    
    int: ID of the Scene
  - getName
```
public java.lang.String getName()
```
    This function is used to get Name of the Scene.
    
    Returns:
    
    String: Name of the Scene
  - getParent
```
public Network getParent()
```
    This function is used to get network that this scene belongs to.
    
    Returns:
    
    Network: parent network of the Scene
  - getResourceConditions
```
public java.util.List<ResourceCondition> getResourceConditions()
```
    A function to fetch resource conditions for this rule.
    
    Returns:
    
    list of Resource conditions defined by user
    
    See Also:
    
    ResourceCondition
  - 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
    
    See Also:
    
    ScheduleCondition
  - getResourceActions
```
public java.util.List<ResourceAction> getResourceActions()
```
    This function fetches the resource actions for this rule.
    
    Returns:
    
    list of resource actions set for this rule.
    
    See Also:
    
    ResourceAction
  - 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
    
    See Also:
    
    Scene
  - isReady
```
public boolean isReady()
```
    A function suggesting if the rule is created 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 retrieved from cache.
    
    Returns:
    
    boolean: state if the rule is dummy or not.
  - internalClearAddResourceConditions
```
protected void internalClearAddResourceConditions(java.util.Collection<ResourceCondition> resourceConditions)
```
    A function that would be triggered when resourceConditions is updated.
    
    Parameters:
    
    resourceConditions - resourceConditions which needs to be added to resourceConditions.
  - internalClearAddScheduleConditions
```
protected void internalClearAddScheduleConditions(java.util.Collection<ScheduleCondition> scheduleConditions)
```
    A function that would be triggered when scheduleConditions is updated.
    
    Parameters:
    
    scheduleConditions - ScheduleCondition collections which needs to be added to scheduleConditions.
  - internalClearAddResourceActions
```
protected void internalClearAddResourceActions(java.util.Collection<ResourceAction> resourceActions)
```
    A function that would be triggered when resourceActions of the rule is updated.
    
    Parameters:
    
    resourceActions - ResourceAction collection which needs to be added to resourceActions.
  - internalClearAddSceneActions
```
protected void internalClearAddSceneActions(java.util.Collection<Scene> scenesActions)
```
    A function that would be triggered when sceneActions of the rule is updated.
    
    Parameters:
    
    scenesActions - SceneActions collections which needs to added to sceneActions.
  - internalSetName
```
protected void internalSetName(java.lang.String name)
```
    A function that would be triggered when name is updated.
    
    Parameters:
    
    name - Updated name of the rule.
  - internalSetParent
```
protected void internalSetParent(Network parent)
```
    A function that would be triggered when parent network is updated.
    
    Parameters:
    
    parent - Network which is the parent of the rule.
  - internalMarkAsReady
```
protected void internalMarkAsReady()
```
    A function that will be triggered to mark this rule as ready.
  - 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

Class Rule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_RULE_ID

Constructor Detail

Rule

Method Detail

getId

getName

getParent

getResourceConditions

getScheduleConditions

getResourceActions

getSceneActions

isReady

internalClearAddResourceConditions

internalClearAddScheduleConditions

internalClearAddResourceActions

internalClearAddSceneActions

internalSetName

internalSetParent

internalMarkAsReady

hashCode

toString