org.openbase.bco.registry.lib.provider

Interface UnitConfigCollectionProvider

public interface UnitConfigCollectionProvider

Method Summary

Modifier and Type	Method and Description
Boolean	containsUnitConfigById(String unitConfigId)
rst.domotic.unit.UnitConfigType.UnitConfig	getUnitConfigById(String unitConfigId)
List<rst.domotic.unit.UnitConfigType.UnitConfig>	getUnitConfigs()
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.

Method Detail

getUnitConfigs

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

Throws:

org.openbase.jul.exception.CouldNotPerformException

containsUnitConfigById

Boolean containsUnitConfigById(String unitConfigId)
                        throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigById

rst.domotic.unit.UnitConfigType.UnitConfig getUnitConfigById(String unitConfigId)
                                                      throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

getUnitConfigs

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.

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.