buzz.getcoco.iot

Class Scene

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 class captures the scene defined by the user in a network, which when triggered causes an action defined on the resource .

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SCENE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addResourceActions(ResourceAction[] resourceActions, Network.NetworkManagementStatusListener listener)
boolean	containsResourceAction(int resourceActionId)
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)
java.util.Map<java.lang.Integer,ResourceAction>	getResourceActionMap() A function to get the actions that get executed with the scene.
int	hashCode()
protected void	internalAddResourceAction(ResourceAction resourceAction)
protected void	internalMarkAsReady()
protected void	internalRemoveResourceAction(int resourceActionId)
protected void	internalSetMetadata(java.lang.String metadata)
protected void	internalSetName(java.lang.String name)
protected void	internalSetParent(Network parent)
protected void	internalUpdateResourceAction(ResourceAction resourceAction)
boolean	isReady() A function suggesting if the scene is made from NativeCallbacks.sceneInfoCallback(boolean, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String[], java.lang.Object) or because of state retrieval.
java.util.Iterator<ResourceAction>	iterator()
void	removeResourceActions(ResourceAction[] resourceActions, Network.NetworkManagementStatusListener listener)
void	saveResourceActions(ResourceAction[] resourceActions, Network.NetworkManagementStatusListener listener)
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)

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

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.

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)

updateResourceActions

public void updateResourceActions(int[] resourceActionIds,
                                  ResourceAction[] resourceActions,
                                  Network.NetworkManagementStatusListener listener)

saveResourceActions

public void saveResourceActions(ResourceAction[] resourceActions,
                                Network.NetworkManagementStatusListener listener)

removeResourceActions

public void removeResourceActions(ResourceAction[] resourceActions,
                                  Network.NetworkManagementStatusListener listener)

setMetadata

public void setMetadata(java.lang.String metadata,
                        Network.NetworkManagementStatusListener listener)

A function to set the metadata of the current scene.

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 actions that get executed with the scene.

Returns:

The map containing the IDs and the actions of the scene

getResourceAction

public ResourceAction getResourceAction(int resourceActionId)

internalAddResourceAction

protected void internalAddResourceAction(ResourceAction resourceAction)

containsResourceAction

public boolean containsResourceAction(int resourceActionId)

internalUpdateResourceAction

protected void internalUpdateResourceAction(ResourceAction resourceAction)

internalRemoveResourceAction

protected void internalRemoveResourceAction(int resourceActionId)

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

isReady

public boolean isReady()

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

Returns:

boolean: state if the scene is dummy or not.

internalSetName

protected void internalSetName(java.lang.String name)

internalSetMetadata

protected void internalSetMetadata(java.lang.String metadata)

internalSetParent

protected void internalSetParent(Network parent)

internalMarkAsReady

protected void internalMarkAsReady()

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>