org.openbase.bco.registry.scene.lib

Interface SceneRegistry

All Superinterfaces:

org.openbase.jul.pattern.provider.DataProvider<rst.domotic.registry.SceneRegistryDataType.SceneRegistryData>, org.openbase.jul.iface.Shutdownable

public interface SceneRegistry
extends org.openbase.jul.pattern.provider.DataProvider<rst.domotic.registry.SceneRegistryDataType.SceneRegistryData>, org.openbase.jul.iface.Shutdownable

Author:

Divine Threepwood

Nested Class Summary

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Method Summary

Modifier and Type	Method and Description
Boolean	containsSceneConfig(rst.domotic.unit.UnitConfigType.UnitConfig sceneUnitConfig)
Boolean	containsSceneConfigById(String sceneUnitConfigId)
rst.domotic.unit.UnitConfigType.UnitConfig	getSceneConfigById(String sceneUnitConfigId)
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getSceneConfigs()
Boolean	isSceneConfigRegistryConsistent() Method returns true if the underling registry is marked as consistent.
Boolean	isSceneConfigRegistryReadOnly()
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	registerSceneConfig(rst.domotic.unit.UnitConfigType.UnitConfig sceneUnitConfig)
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	removeSceneConfig(rst.domotic.unit.UnitConfigType.UnitConfig sceneUnitConfig)
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	updateSceneConfig(rst.domotic.unit.UnitConfigType.UnitConfig sceneUnitConfig)

Methods inherited from interface org.openbase.jul.pattern.provider.DataProvider

addDataObserver, getData, getDataClass, getDataFuture, isDataAvailable, removeDataObserver, waitForData, waitForData

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook, shutdown

Method Detail

registerSceneConfig

Future<rst.domotic.unit.UnitConfigType.UnitConfig> registerSceneConfig(rst.domotic.unit.UnitConfigType.UnitConfig sceneUnitConfig)
                                                                throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsSceneConfig

Boolean containsSceneConfig(rst.domotic.unit.UnitConfigType.UnitConfig sceneUnitConfig)
                     throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsSceneConfigById

Boolean containsSceneConfigById(String sceneUnitConfigId)
                         throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

updateSceneConfig

Future<rst.domotic.unit.UnitConfigType.UnitConfig> updateSceneConfig(rst.domotic.unit.UnitConfigType.UnitConfig sceneUnitConfig)
                                                              throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

removeSceneConfig

Future<rst.domotic.unit.UnitConfigType.UnitConfig> removeSceneConfig(rst.domotic.unit.UnitConfigType.UnitConfig sceneUnitConfig)
                                                              throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getSceneConfigById

rst.domotic.unit.UnitConfigType.UnitConfig getSceneConfigById(String sceneUnitConfigId)
                                                       throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getSceneConfigs

List<rst.domotic.unit.UnitConfigType.UnitConfig> getSceneConfigs()
                                                          throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

isSceneConfigRegistryReadOnly

Boolean isSceneConfigRegistryReadOnly()
                               throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

isSceneConfigRegistryConsistent

Boolean isSceneConfigRegistryConsistent()
                                 throws org.openbase.jul.exception.CouldNotPerformException

Method returns true if the underling registry is marked as consistent.

Returns:

if the scene config registry is consistent

Throws:

org.openbase.jul.exception.CouldNotPerformException - if the check fails