org.openbase.bco.registry.unit.lib

Interface UnitRegistry

All Superinterfaces:

org.openbase.jul.pattern.provider.DataProvider<rst.domotic.registry.UnitRegistryDataType.UnitRegistryData>, RootLocationConfigProvider, org.openbase.jul.iface.Shutdownable, UnitConfigCollectionProvider, UnitTransformationProviderRegistry<rst.domotic.registry.UnitRegistryDataType.UnitRegistryData>

public interface UnitRegistry
extends org.openbase.jul.pattern.provider.DataProvider<rst.domotic.registry.UnitRegistryDataType.UnitRegistryData>, UnitTransformationProviderRegistry<rst.domotic.registry.UnitRegistryDataType.UnitRegistryData>, UnitConfigCollectionProvider, org.openbase.jul.iface.Shutdownable

Nested Class Summary

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

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_RADIUS The default radius used for the unit by coordinate lookup is set to 1 metre.

Method Summary

Modifier and Type	Method and Description
Boolean	containsServiceTemplate(rst.domotic.service.ServiceTemplateType.ServiceTemplate serviceTemplate)
Boolean	containsServiceTemplateById(String serviceTemplateId)
Boolean	containsUnitConfig(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
default Boolean	containsUnitConfigByAlias(String alias)
Boolean	containsUnitGroupConfig(rst.domotic.unit.UnitConfigType.UnitConfig groupConfig)
Boolean	containsUnitGroupConfigById(String groupConfigId)
Boolean	containsUnitTemplate(rst.domotic.unit.UnitTemplateType.UnitTemplate unitTemplate)
Boolean	containsUnitTemplateById(String unitTemplateId)
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getBaseUnitConfigs() Method returns a list of all globally registered base units.
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getDalUnitConfigs() Method returns a list of all globally registered dal units.
List<rst.domotic.service.ServiceConfigType.ServiceConfig>	getServiceConfigs()
List<rst.domotic.service.ServiceConfigType.ServiceConfig>	getServiceConfigs(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
rst.domotic.service.ServiceTemplateType.ServiceTemplate	getServiceTemplateById(String serviceTemplateId)
rst.domotic.service.ServiceTemplateType.ServiceTemplate	getServiceTemplateByType(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType type)
List<rst.domotic.service.ServiceTemplateType.ServiceTemplate>	getServiceTemplates()
List<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType>	getSubUnitTypes(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type) Get all sub types of a unit type.
default List<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType>	getSubUnitTypesOfUnitType(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type) Deprecated. please use getSubUnitTypes instead
List<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType>	getSuperUnitTypes(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type) Get all super types of a unit type.
default rst.domotic.unit.UnitConfigType.UnitConfig	getUnitConfigByAlias(String unitAlias) Method returns the unit matching the given alias.
rst.domotic.unit.UnitConfigType.UnitConfig	getUnitConfigByScope(rst.rsb.ScopeType.Scope scope) Method return the unit config which is registered for the given scope.
default List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigs(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type) Method returns a list of all globally registered units of the given type.
default List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByCoordinate(rst.math.Vec3DDoubleType.Vec3DDouble coordinate)
default List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByCoordinate(rst.math.Vec3DDoubleType.Vec3DDouble coordinate, double radius)
default List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByCoordinate(rst.math.Vec3DDoubleType.Vec3DDouble coordinate, double radius, rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType) Method returns a list of UnitConfig instances sorted by the distance to the given coordinate starting with the lowest one.
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByLabel(String unitConfigLabel) Method returns all registered units with the given label.
default List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByLabelAndUnitType(String unitConfigLabel, rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
default List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByService(List<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> serviceTypes)
default List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByServices(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType... serviceTypes)
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByUnitGroupConfig(rst.domotic.unit.UnitConfigType.UnitConfig groupConfig)
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigsByUnitTypeAndServiceTypes(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type, List<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> serviceTypes)
rst.domotic.unit.UnitConfigType.UnitConfig	getUnitGroupConfigById(String groupConfigId)
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitGroupConfigs()
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitGroupConfigsByServiceTypes(List<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> serviceTypes)
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitGroupConfigsByUnitConfig(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitGroupConfigsByUnitType(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
default String	getUnitScopeByAlias(String alias)
default String	getUnitScopeById(String id)
rst.domotic.unit.UnitTemplateType.UnitTemplate	getUnitTemplateById(String unitTemplate)
rst.domotic.unit.UnitTemplateType.UnitTemplate	getUnitTemplateByType(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
List<rst.domotic.unit.UnitTemplateType.UnitTemplate>	getUnitTemplates()
Boolean	isAgentUnitRegistryConsistent()
Boolean	isAgentUnitRegistryReadOnly()
Boolean	isAppUnitRegistryConsistent()
Boolean	isAppUnitRegistryReadOnly()
Boolean	isAuthorizationGroupUnitRegistryConsistent()
Boolean	isAuthorizationGroupUnitRegistryReadOnly()
Boolean	isConnectionUnitRegistryConsistent()
Boolean	isConnectionUnitRegistryReadOnly()
Boolean	isDalUnitConfigRegistryConsistent()
Boolean	isDalUnitConfigRegistryReadOnly()
Boolean	isDeviceUnitRegistryConsistent()
Boolean	isDeviceUnitRegistryReadOnly()
Boolean	isLocationUnitRegistryConsistent()
Boolean	isLocationUnitRegistryReadOnly()
Boolean	isSceneUnitRegistryConsistent()
Boolean	isSceneUnitRegistryReadOnly()
Boolean	isServiceTemplateRegistryConsistent()
Boolean	isServiceTemplateRegistryReadOnly()
Boolean	isUnitConfigRegistryConsistent() Method returns true if the underling registry is marked as consistent.
Boolean	isUnitConfigRegistryReadOnly()
Boolean	isUnitGroupConfigRegistryConsistent()
Boolean	isUnitGroupConfigRegistryReadOnly()
Boolean	isUnitGroupUnitRegistryConsistent()
Boolean	isUnitGroupUnitRegistryReadOnly()
Boolean	isUnitTemplateRegistryConsistent()
Boolean	isUnitTemplateRegistryReadOnly()
Boolean	isUserUnitRegistryConsistent()
Boolean	isUserUnitRegistryReadOnly()
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	registerUnitConfig(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
Future<rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue>	registerUnitConfigAuthenticated(rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedValue)
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	registerUnitGroupConfig(rst.domotic.unit.UnitConfigType.UnitConfig groupConfig)
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	removeUnitConfig(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
Future<rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue>	removeUnitConfigAuthenticated(rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedValue)
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	removeUnitGroupConfig(rst.domotic.unit.UnitConfigType.UnitConfig groupConfig)
Future<rst.domotic.service.ServiceTemplateType.ServiceTemplate>	updateServiceTemplate(rst.domotic.service.ServiceTemplateType.ServiceTemplate serviceTemplate)
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	updateUnitConfig(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
Future<rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue>	updateUnitConfigAuthenticated(rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedValue)
Future<rst.domotic.unit.UnitConfigType.UnitConfig>	updateUnitGroupConfig(rst.domotic.unit.UnitConfigType.UnitConfig groupConfig)
Future<rst.domotic.unit.UnitTemplateType.UnitTemplate>	updateUnitTemplate(rst.domotic.unit.UnitTemplateType.UnitTemplate unitTemplate)
void	validateData()
default void	verifyUnitGroupUnitConfig(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)

Methods inherited from interface org.openbase.bco.registry.unit.lib.provider.UnitTransformationProviderRegistry

getRootLocationConfig, getRootToUnitTransform3D, getRootToUnitTransformation, getRootToUnitTransformationFuture, getUnitBoundingBoxCenterGlobalPoint3d, getUnitBoundingBoxCenterPoint3d, getUnitPositionGlobal, getUnitPositionGlobalPoint3d, getUnitPositionGlobalVec3DDouble, getUnitPositionGlobalVector3d, getUnitRotationGlobal, getUnitRotationGlobalQuat4d, getUnitShape, getUnitShape, getUnitToRootTransform3D, getUnitToRootTransformation, getUnitToRootTransformationFuture, getUnitTransformation, getUnitTransformationFuture, lookupUnitTransformation

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

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

Methods inherited from interface org.openbase.bco.registry.lib.provider.UnitConfigCollectionProvider

containsUnitConfigById, getUnitConfigById, getUnitConfigs

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

registerShutdownHook, registerShutdownHook, shutdown

Field Detail

DEFAULT_RADIUS

static final double DEFAULT_RADIUS

The default radius used for the unit by coordinate lookup is set to 1 metre.

See Also:

Constant Field Values

Method Detail

registerUnitConfig

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

registerUnitConfigAuthenticated

Future<rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue> registerUnitConfigAuthenticated(rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedValue)
                                                                                                      throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

updateUnitConfig

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

updateUnitConfigAuthenticated

Future<rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue> updateUnitConfigAuthenticated(rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedValue)
                                                                                                    throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

removeUnitConfig

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

removeUnitConfigAuthenticated

Future<rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue> removeUnitConfigAuthenticated(rst.domotic.authentication.AuthenticatedValueType.AuthenticatedValue authenticatedValue)
                                                                                                    throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsUnitConfig

Boolean containsUnitConfig(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
                    throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsUnitConfigByAlias

default Boolean containsUnitConfigByAlias(String alias)
                                   throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigsByServices

default List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitConfigsByServices(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType... serviceTypes)
                                                                           throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigsByService

default List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitConfigsByService(List<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> serviceTypes)
                                                                          throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitScopeById

default String getUnitScopeById(String id)
                         throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitScopeByAlias

default String getUnitScopeByAlias(String alias)
                            throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUnitConfigRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUnitConfigRegistryConsistent

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

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

Returns:

if the UnitConfig registry is consistent

Throws:

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

updateUnitTemplate

Future<rst.domotic.unit.UnitTemplateType.UnitTemplate> updateUnitTemplate(rst.domotic.unit.UnitTemplateType.UnitTemplate unitTemplate)
                                                                   throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsUnitTemplate

Boolean containsUnitTemplate(rst.domotic.unit.UnitTemplateType.UnitTemplate unitTemplate)
                      throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsUnitTemplateById

Boolean containsUnitTemplateById(String unitTemplateId)
                          throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitTemplateById

rst.domotic.unit.UnitTemplateType.UnitTemplate getUnitTemplateById(String unitTemplate)
                                                            throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitTemplates

List<rst.domotic.unit.UnitTemplateType.UnitTemplate> getUnitTemplates()
                                                               throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitTemplateByType

rst.domotic.unit.UnitTemplateType.UnitTemplate getUnitTemplateByType(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
                                                              throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUnitTemplateRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUnitTemplateRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

registerUnitGroupConfig

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

updateUnitGroupConfig

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

removeUnitGroupConfig

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsUnitGroupConfig

Boolean containsUnitGroupConfig(rst.domotic.unit.UnitConfigType.UnitConfig groupConfig)
                         throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsUnitGroupConfigById

Boolean containsUnitGroupConfigById(String groupConfigId)
                             throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigByAlias

default rst.domotic.unit.UnitConfigType.UnitConfig getUnitConfigByAlias(String unitAlias)
                                                                 throws org.openbase.jul.exception.CouldNotPerformException

Method returns the unit matching the given alias. An alias is an unique identifiere of units.

Hint: If you want to address more than one unit with an alias than create a unit group of such units and define an alias for those group.

Parameters:

unitAlias - the alias to identify the unit.

Returns:

the unit config referred by the alias.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if no unit is matching the given alias.

org.openbase.jul.exception.CouldNotPerformException - is thrown if something went wrong during the lookup.

getUnitConfigsByLabel

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

Method returns all registered units with the given label. Label resolving is done case insensitive!

Parameters:

unitConfigLabel -

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigsByLabelAndUnitType

default List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitConfigsByLabelAndUnitType(String unitConfigLabel,
                                                                                          rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
                                                                                   throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigs

default List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitConfigs(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
                                                                 throws org.openbase.jul.exception.CouldNotPerformException

Method returns a list of all globally registered units of the given type.

Note: The type UnitType.UNKNOWN is used as wildcard and will return a list of all registered units.

Specified by:

getUnitConfigs in interface UnitConfigCollectionProvider

Parameters:

type - the unit type to filter.

Returns:

a list of unit configurations.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown in case something goes wrong during the request.

getDalUnitConfigs

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

Method returns a list of all globally registered dal units. Dal units are all units introduced via the unit templates which are not base units. Base units are units of the following types: LOCATION, CONNECTION, SCENE, AGENT, APP, DEVICE, USER, AUTHORIZATION_GROUP, UNIT_GROUP

Returns:

a list of dal units.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown in case something goes wrong during the request.

getBaseUnitConfigs

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

Method returns a list of all globally registered base units. Base units are units of the following types: LOCATION, CONNECTION, SCENE, AGENT, APP, DEVICE, USER, AUTHORIZATION_GROUP, UNIT_GROUP

Returns:

a list of base units.

Throws:

org.openbase.jul.exception.CouldNotPerformException - is thrown in case something goes wrong during the request.

getServiceConfigs

List<rst.domotic.service.ServiceConfigType.ServiceConfig> getServiceConfigs()
                                                                     throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getServiceConfigs

List<rst.domotic.service.ServiceConfigType.ServiceConfig> getServiceConfigs(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType serviceType)
                                                                     throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUnitGroupConfigRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUnitGroupConfigRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitGroupConfigById

rst.domotic.unit.UnitConfigType.UnitConfig getUnitGroupConfigById(String groupConfigId)
                                                           throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitGroupConfigs

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitGroupConfigsByUnitConfig

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitGroupConfigsByUnitType

List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitGroupConfigsByUnitType(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
                                                                        throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitGroupConfigsByServiceTypes

List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitGroupConfigsByServiceTypes(List<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> serviceTypes)
                                                                            throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigsByUnitGroupConfig

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigsByUnitTypeAndServiceTypes

List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitConfigsByUnitTypeAndServiceTypes(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type,
                                                                                         List<rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType> serviceTypes)
                                                                                  throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigByScope

rst.domotic.unit.UnitConfigType.UnitConfig getUnitConfigByScope(rst.rsb.ScopeType.Scope scope)
                                                         throws org.openbase.jul.exception.CouldNotPerformException

Method return the unit config which is registered for the given scope. A NotAvailableException is thrown if no unit config is registered for the given scope.

Parameters:

scope -

Returns:

the unit config matching the given scope.

Throws:

org.openbase.jul.exception.CouldNotPerformException

getSubUnitTypesOfUnitType

@Deprecated
default List<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType> getSubUnitTypesOfUnitType(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
                                                                                                     throws org.openbase.jul.exception.CouldNotPerformException

Deprecated. please use getSubUnitTypes instead

Get all sub types of a unit type. E.g. COLORABLE_LIGHT and DIMMABLE_LIGHT are sub types of LIGHT.

Parameters:

type - the super type whose sub types are searched

Returns:

all types of which the given type is a super type

Throws:

org.openbase.jul.exception.CouldNotPerformException

getSubUnitTypes

List<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType> getSubUnitTypes(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
                                                                       throws org.openbase.jul.exception.CouldNotPerformException

Get all sub types of a unit type. E.g. COLORABLE_LIGHT and DIMMABLE_LIGHT are sub types of LIGHT.

Parameters:

type - the super type whose sub types are searched

Returns:

all types of which the given type is a super type

Throws:

org.openbase.jul.exception.CouldNotPerformException

getSuperUnitTypes

List<rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType> getSuperUnitTypes(rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType type)
                                                                         throws org.openbase.jul.exception.CouldNotPerformException

Get all super types of a unit type. E.g. DIMMABLE_LIGHT and LIGHT are super types of COLORABLE_LIGHT.

Parameters:

type - the type whose super types are returned

Returns:

all super types of a given unit type

Throws:

org.openbase.jul.exception.CouldNotPerformException

verifyUnitGroupUnitConfig

default void verifyUnitGroupUnitConfig(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
                                throws org.openbase.jul.exception.VerificationFailedException

Throws:

org.openbase.jul.exception.VerificationFailedException

isDalUnitConfigRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUserUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isAuthorizationGroupUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isDeviceUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUnitGroupUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isLocationUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isConnectionUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isAgentUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isAppUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isSceneUnitRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isDalUnitConfigRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUserUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isAuthorizationGroupUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isDeviceUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isUnitGroupUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isLocationUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isConnectionUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isAgentUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isAppUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isSceneUnitRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

validateData

void validateData()
           throws org.openbase.jul.exception.InvalidStateException

Throws:

org.openbase.jul.exception.InvalidStateException

updateServiceTemplate

Future<rst.domotic.service.ServiceTemplateType.ServiceTemplate> updateServiceTemplate(rst.domotic.service.ServiceTemplateType.ServiceTemplate serviceTemplate)
                                                                               throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsServiceTemplate

Boolean containsServiceTemplate(rst.domotic.service.ServiceTemplateType.ServiceTemplate serviceTemplate)
                         throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsServiceTemplateById

Boolean containsServiceTemplateById(String serviceTemplateId)
                             throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getServiceTemplateById

rst.domotic.service.ServiceTemplateType.ServiceTemplate getServiceTemplateById(String serviceTemplateId)
                                                                        throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getServiceTemplates

List<rst.domotic.service.ServiceTemplateType.ServiceTemplate> getServiceTemplates()
                                                                           throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getServiceTemplateByType

rst.domotic.service.ServiceTemplateType.ServiceTemplate getServiceTemplateByType(rst.domotic.service.ServiceTemplateType.ServiceTemplate.ServiceType type)
                                                                          throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

isServiceTemplateRegistryReadOnly

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

isServiceTemplateRegistryConsistent

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigsByCoordinate

default List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitConfigsByCoordinate(rst.math.Vec3DDoubleType.Vec3DDouble coordinate)
                                                                             throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigsByCoordinate

default List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitConfigsByCoordinate(rst.math.Vec3DDoubleType.Vec3DDouble coordinate,
                                                                                    double radius)
                                                                             throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigsByCoordinate

default List<rst.domotic.unit.UnitConfigType.UnitConfig> getUnitConfigsByCoordinate(rst.math.Vec3DDoubleType.Vec3DDouble coordinate,
                                                                                    double radius,
                                                                                    rst.domotic.unit.UnitTemplateType.UnitTemplate.UnitType unitType)
                                                                             throws org.openbase.jul.exception.CouldNotPerformException

Method returns a list of UnitConfig instances sorted by the distance to the given coordinate starting with the lowest one. The lookup time can be reduced by filtering the results with a UnitType where the UnitType.UNKNOWN is used as wildcard. The given radius can be used to limit the result as well but will not speed up the lookup.

Parameters:

coordinate -

radius -

unitType -

Returns:

Throws:

org.openbase.jul.exception.CouldNotPerformException