Scene (cococlientsdk-java 0.28.2 API)

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

All Implemented Interfaces:

java.lang.Iterable<ResourceAction>
```
public class Scene
extends java.lang.Object
implements java.lang.Iterable<ResourceAction>
```
Scene acts as tool to change current state of Resources to a state defined by the user. User can manually trigger scene or add scene as a scene action in a rule.
Simply, scene is a list of Commands encapsulated using ResourceActions, which will be executed on calling execute()
Scene class acts as blueprint for scenes present in a Network. User can have any scenes as a part of his/her network.
Scenes can be added using Network.createScene(String, Network.NetworkManagementStatusListener), removed using Network.deleteScene(Scene, Network.NetworkManagementStatusListener), modified using Network.SaveSceneResourceActions by the user.

See Also:

Rule.getSceneActions()

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_SCENE_ID
Default ID of a scene.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_SCENE_ID` Default ID of a scene.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Scene(int sceneId, Network parent)
The constructor for the current class.

Constructors
Modifier	Constructor and Description
`protected`	`Scene(int sceneId, Network parent)` The constructor for the current class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addResourceActions(ResourceAction[] resourceActions, Network.NetworkManagementStatusListener listener)` A function to add `ResourceAction`'s to scene.
`boolean`	`containsResourceAction(int resourceActionId)` A function to check if a `ResourceAction` exists with given ID.
`void`	`execute()` A function to execute the scene.
`int`	`getId()` A function to get the ID of the scene.
`java.lang.String`	`getMetadata()` A function to return the metadata of the scene.
`java.lang.String`	`getName()` A function to get the name of the scene.
`Network`	`getParent()` A function to get the parent network of the current scene.
`ResourceAction`	`getResourceAction(int resourceActionId)` A function to get `ResourceAction` given the ID.
`java.util.Map<java.lang.Integer,ResourceAction>`	`getResourceActionMap()` A function to get the map of `ResourceAction`'s and there ID's.
`int`	`hashCode()`
`protected void`	`internalAddResourceAction(ResourceAction resourceAction)` A function that would be triggered when `ResourceAction` is added to scene.
`protected void`	`internalMarkAsReady()` A function that would be triggered to mark this scene as ready.
`protected void`	`internalRemoveResourceAction(int resourceActionId)` A function that would be triggered when `ResourceAction` is remove from scene.
`protected void`	`internalSetMetadata(java.lang.String metadata)` A function that would be triggered when `metadata` is updated.
`protected void`	`internalSetName(java.lang.String name)` A function that would be triggered when `name` is updated.
`protected void`	`internalSetParent(Network parent)` A function would be triggered when parent of the scene is updated.
`protected void`	`internalUpdateResourceAction(ResourceAction resourceAction)` A function that would be triggered when a `ResourceAction` is updated.
`boolean`	`isReady()` A function suggesting if the scene is created from `NativeCallbacks.sceneInfoCallback(boolean, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String[], java.lang.Object)` or retrieved from cache.
`java.util.Iterator<ResourceAction>`	`iterator()`
`void`	`removeResourceActions(ResourceAction[] resourceActions, Network.NetworkManagementStatusListener listener)` A function to remove `ResourceAction`'s from scene.
`void`	`saveResourceActions(ResourceAction[] resourceActions, Network.NetworkManagementStatusListener listener)` A function to save `ResourceAction`'s to the scene.
`void`	`setMetadata(java.lang.String metadata, Network.NetworkManagementStatusListener listener)` A function to set the metadata of the current scene.
`void`	`setName(java.lang.String name, Network.NetworkManagementStatusListener listener)` A function to set the name of the scene.
`java.lang.String`	`toString()`
`void`	`updateResourceActions(int[] resourceActionIds, ResourceAction[] resourceActions, Network.NetworkManagementStatusListener listener)` A function to update `ResourceAction`'s of the scene.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - DEFAULT_SCENE_ID
```
public static final int DEFAULT_SCENE_ID
```
    Default ID of a scene.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Scene
```
protected Scene(int sceneId,
                Network parent)
```
    The constructor for the current class.
    
    Parameters:
    
    sceneId - The unique identifier of the object
    
    parent - The parent network of the scene
- Method Detail
  - getId
```
public int getId()
```
    A function to get the ID of the scene.
    
    Returns:
    
    int: sceneId of the current scene
  - getName
```
public java.lang.String getName()
```
    A function to get the name of the scene.
    
    Returns:
    
    String: The name of the current scene
  - setName
```
public void setName(java.lang.String name,
                    Network.NetworkManagementStatusListener listener)
```
    A function to set the name of the scene.
```
   
     johnNetwork
     .setName(newName,
     (commandStatus, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code
       }
     });
   
 
```
    Parameters:
    
    name - The name that has to be assigned
    
    listener - The listener that will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - addResourceActions
```
public void addResourceActions(ResourceAction[] resourceActions,
                               Network.NetworkManagementStatusListener listener)
```
    A function to add ResourceAction's to scene.
    Let r1, r2, r2 be three ResourceAction's that are to be added.
```
   
     scene.addResourceAction(new ResourceAction[]{r1, r2, r3},
     (response, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code.
       }
     });
   
 
```
    Parameters:
    
    resourceActions - Resource actions that are to be added to this scene.
    
    listener - The listener that will be triggered #networkManagementCommandCallback(Network, CommandResponse)
  - updateResourceActions
```
public void updateResourceActions(int[] resourceActionIds,
                                  ResourceAction[] resourceActions,
                                  Network.NetworkManagementStatusListener listener)
```
    A function to update ResourceAction's of the scene.
    
    Parameters:
    
    resourceActionIds - Ids of resource action that are to be updated.
    
    resourceActions - Resource actions that are to be updated.
    
    listener - The listener that will be triggered #networkManagementCommandCallback(Network, CommandResponse).
  - saveResourceActions
```
public void saveResourceActions(ResourceAction[] resourceActions,
                                Network.NetworkManagementStatusListener listener)
```
    A function to save ResourceAction's to the scene.
    
    Parameters:
    
    resourceActions - Resource actions that are to be saved.
    
    listener - The listener that will be triggered
  - removeResourceActions
```
public void removeResourceActions(ResourceAction[] resourceActions,
                                  Network.NetworkManagementStatusListener listener)
```
    A function to remove ResourceAction's from scene.
    Let r1, r2, r2 be three ResourceAction's that are to be removed.
```
   
     scene.removeResourceAction(new ResourceAction[]{r1, r2, r2},
     (command, throwable) &#45;&gt; {
       if (null != )
     });
   
 
```
    Parameters:
    
    resourceActions - Resource actions that are to be removed
    
    listener - The listener that will be triggered (Network, CommandResponse)
  - setMetadata
```
public void setMetadata(java.lang.String metadata,
                        Network.NetworkManagementStatusListener listener)
```
    A function to set the metadata of the current scene.
```
   
     scene.setMetaData(metaData, (commandResponse, throwable) &#45;&gt; {
       if (null != throwable) {
         // client specific code.
       }
     });
   
 
```
    Parameters:
    
    metadata - The metadata to be assigned
    
    listener - The listener that will be triggered with CallbacksInterface.networkManagementCommandCallback(buzz.getcoco.iot.Network, buzz.getcoco.iot.CommandResponse<?>)
  - execute
```
public void execute()
```
    A function to execute the scene.
    
    Throws:
    
    java.lang.RuntimeException - on connection failures and other similar errors
  - getMetadata
```
public java.lang.String getMetadata()
```
    A function to return the metadata of the scene.
    
    Returns:
    
    String: The metadata of the scene
  - getParent
```
public Network getParent()
```
    A function to get the parent network of the current scene.
    
    Returns:
    
    Network: The parent network of the scene
  - getResourceActionMap
```
public java.util.Map<java.lang.Integer,ResourceAction> getResourceActionMap()
```
    A function to get the map of ResourceAction's and there ID's.
    
    Returns:
    
    The map containing the IDs and the actions of the scene
  - getResourceAction
```
public ResourceAction getResourceAction(int resourceActionId)
```
    A function to get ResourceAction given the ID.
    
    Parameters:
    
    resourceActionId - ID of the ResourceAction
    
    Returns:
    
    Returns the ResourceAction associated with the ID.
  - internalAddResourceAction
```
protected void internalAddResourceAction(ResourceAction resourceAction)
```
    A function that would be triggered when ResourceAction is added to scene.
    
    Parameters:
    
    resourceAction - Resource action that is added.
  - containsResourceAction
```
public boolean containsResourceAction(int resourceActionId)
```
    A function to check if a ResourceAction exists with given ID.
    
    Parameters:
    
    resourceActionId - ID of the ResourceAction that needs to be looked up.
    
    Returns:
    
    boolean - flag representing whether ResourceAction exists with given ID.
  - internalUpdateResourceAction
```
protected void internalUpdateResourceAction(ResourceAction resourceAction)
```
    A function that would be triggered when a ResourceAction is updated.
    
    Parameters:
    
    resourceAction - ResourceAction that is updated.
  - internalRemoveResourceAction
```
protected void internalRemoveResourceAction(int resourceActionId)
```
    A function that would be triggered when ResourceAction is remove from scene.
    
    Parameters:
    
    resourceActionId - ID of the resource action.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isReady
```
public boolean isReady()
```
    A function suggesting if the scene is created from NativeCallbacks.sceneInfoCallback(boolean, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String[], java.lang.Object) or retrieved from cache.
    
    Returns:
    
    boolean: state if the scene is created from NativeCallbacks.sceneInfoCallback(boolean, String, int, String, String, String[], Object).
  - internalSetName
```
protected void internalSetName(java.lang.String name)
```
    A function that would be triggered when name is updated.
    
    Parameters:
    
    name - Updated name of the scene.
  - internalSetMetadata
```
protected void internalSetMetadata(java.lang.String metadata)
```
    A function that would be triggered when metadata is updated.
    
    Parameters:
    
    metadata - Updated metadata of scene.
  - internalSetParent
```
protected void internalSetParent(Network parent)
```
    A function would be triggered when parent of the scene is updated.
    
    Parameters:
    
    parent - Network which is the parent of the scene.
  - internalMarkAsReady
```
protected void internalMarkAsReady()
```
    A function that would be triggered to mark this scene as ready.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - iterator
```
public java.util.Iterator<ResourceAction> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<ResourceAction>

Class Scene

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_SCENE_ID

Constructor Detail

Scene

Method Detail

getId

getName

setName

addResourceActions

updateResourceActions

saveResourceActions

removeResourceActions

setMetadata

execute

getMetadata

getParent

getResourceActionMap

getResourceAction

internalAddResourceAction

containsResourceAction

internalUpdateResourceAction

internalRemoveResourceAction

hashCode

isReady

internalSetName

internalSetMetadata

internalSetParent

internalMarkAsReady

toString

iterator