Package org.osgi.service.dal.functions

Interface Types

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String COLD
      The function type is applicable to: Meter - indicates that the Meter measures thermal energy provided by a source. This type can be specified as a value of Function.SERVICE_TYPE.
      static java.lang.String CONTACT
      The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect contact.
      static java.lang.String DOOR
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the door position.
      static java.lang.String FIRE
      The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect fire.
      static java.lang.String FLOW
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the flow level.
      static java.lang.String GAS
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the gas level.
      static java.lang.String HEAT
      The function type is applicable to: Meter - indicates that the Meter measures thermal energy provided by a source. This type can be specified as a value of Function.SERVICE_TYPE.
      static java.lang.String HUMIDITY
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the humidity level.
      static java.lang.String LIGHT
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control light devices.
      static java.lang.String LIQUID
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the liquid level.
      static java.lang.String MOTION
      The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect motion.
      static java.lang.String NOISINESS
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the noise level.
      static java.lang.String OCCUPANCY
      The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect presence.
      static java.lang.String POWER
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the power level.
      static java.lang.String PRESSURE
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the pressure level.
      static java.lang.String RAIN
      The function type is applicable to: MultiLevelSensor - indicates that the MultiLevelSensor can monitor the rain rate.
      static java.lang.String SMOKE
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the smoke level.
      static java.lang.String TEMPERATURE
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control temperature devices.
      static java.lang.String WATER
      The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect water leak.
      static java.lang.String WINDOW
      The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the window position.

    • Field Detail

      • LIGHT

        static final java.lang.String LIGHT
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control light devices. Usually, such devices are called dimmable. MultiLevelControl minimum value can switch off the device and MultiLevelControl maximum value can increase the device light to the maximum possible value.
        • MultiLevelSensor - indicates that the sensor can monitor the light level.
        • BooleanSensor - indicates that the BooleanSensor can detected light. true state means that there is light. false state means that there is no light.
        • BooleanControl - indicates that there is a light device control. true state means that the light device will be turned on. false state means that the light device will be turned off.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • TEMPERATURE

        static final java.lang.String TEMPERATURE
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control temperature devices. For example, such device can be thermostat. MultiLevelControl minimum value is the lowest supported temperature. MultiLevelControl maximum value is the highest supported temperature.
        • MultiLevelSensor - indicates that the sensor can monitor the temperature.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • FLOW

        static final java.lang.String FLOW
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the flow level. MultiLevelControl minimum value is the minimum supported flow level. MultiLevelControl maximum value is the maximum supported flow level.
        • MultiLevelSensor - indicates that the sensor can monitor the flow level.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • PRESSURE

        static final java.lang.String PRESSURE
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the pressure level. MultiLevelControl minimum value is the lowest supported pressure level. MultiLevelControl maximum value is the highest supported pressure level.
        • MultiLevelSensor - indicates that the sensor can monitor the pressure level.
        • Meter - Indicates that the Meter measures pressure.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • HUMIDITY

        static final java.lang.String HUMIDITY
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the humidity level. It's typical functionality for HVAC (heating, ventilation, and air conditioning) devices. MultiLevelControl minimum value is the lowest supported humidity level. MultiLevelControl maximum value is the highest supported humidity level.
        • MultiLevelSensor - indicates that the sensor can monitor the humidity level.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • GAS

        static final java.lang.String GAS
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the gas level. MultiLevelControl minimum value is the lowest supported gas level. MultiLevelControl maximum value is the highest supported gas level.
        • MultiLevelSensor - indicates that the sensor can monitor the gas level.
        • BooleanSensor - indicates that the BooleanSensor supports gas detection. true state means there is gas. false state means that there is no gas.
        • Meter - indicates that the Meter measures the gas consumption.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • SMOKE

        static final java.lang.String SMOKE
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the smoke level. MultiLevelControl minimum value is the lowest supported smoke level. MultiLevelControl maximum value is the highest supported smoke level.
        • MultiLevelSensor - indicates that the sensor can monitor the smoke level.
        • BooleanSensor - indicates that the BooleanSensor can detect smoke. true state means that there is smoke. false state means that there is no smoke.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • DOOR

        static final java.lang.String DOOR
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the door position. MultiLevelControl minimum value can completely close the door. MultiLevelControl maximum value can open the door to the maximum allowed position.
        • MultiLevelSensor - indicates that the sensor can monitor the door position.
        • BooleanSensor - indicates that the BooleanSensor can detect the door state. true state means that the door is opened. false state means that the door is closed.
        • BooleanControl - indicates that there is a door position control. true state means that the door will be opened. false state means that the door will be closed.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • WINDOW

        static final java.lang.String WINDOW
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the window position. MultiLevelControl minimum value can completely close the window. MultiLevelControl maximum value can open the window to the maximum allowed position.
        • MultiLevelSensor - indicates that the sensor can monitor the window position.
        • BooleanSensor - indicates that the BooleanSensor can window state. true state means that the window is opened. false state means that the window is closed.
        • BooleanControl - indicates that there is a window position control. true state means that the window will be opened. false state means that the window will be closed.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • LIQUID

        static final java.lang.String LIQUID
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the liquid level. MultiLevelControl minimum value is the lowest supported liquid level. MultiLevelControl maximum value is the highest supported liquid level.
        • MultiLevelSensor - indicates that the sensor can monitor the liquid level.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • POWER

        static final java.lang.String POWER
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the power level. MultiLevelControl minimum value is the lowest supported power level. MultiLevelControl maximum value is the highest supported power level.
        • MultiLevelSensor - indicates that the sensor can monitor the power level.
        • BooleanSensor - indicates that the BooleanSensor can detect power/no power. true state means that there is power. false state means that there is no power.
        • BooleanControl - indicates that there is electricity control. true state means that the power will be restored. false state means that the power will be cut.
        • Meter - indicates that the Meter measures the power consumption.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • NOISINESS

        static final java.lang.String NOISINESS
        The function type is applicable to:
        • MultiLevelControl - indicates that the MultiLevelControl can control the noise level. MultiLevelControl minimum value is the lowest supported noise level. MultiLevelControl maximum value is the highest supported noise level.
        • MultiLevelSensor - indicates that the sensor can monitor the noise level.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • RAIN

        static final java.lang.String RAIN
        The function type is applicable to:
        • MultiLevelSensor - indicates that the MultiLevelSensor can monitor the rain rate. It's not applicable to MultiLevelControl.
        • BooleanSensor - indicates that the BooleanSensor can detect rain. true state means that there is rain. false state means that there is no rain.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • CONTACT

        static final java.lang.String CONTACT
        The function type is applicable to:
        • BooleanSensor - indicates that the BooleanSensor can detect contact. true state means that there is contact. false state means that there is no contact.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • FIRE

        static final java.lang.String FIRE
        The function type is applicable to:
        • BooleanSensor - indicates that the BooleanSensor can detect fire. true state means that there is fire. false state means that there is no fire.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • OCCUPANCY

        static final java.lang.String OCCUPANCY
        The function type is applicable to:
        • BooleanSensor - indicates that the BooleanSensor can detect presence. true state means that someone is detected. false state means that nobody is detected.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • WATER

        static final java.lang.String WATER
        The function type is applicable to:
        • BooleanSensor - indicates that the BooleanSensor can detect water leak. true state means that there is water leak. false state means that there is no water leak.
        • Meter - indicates that the Meter measures water consumption.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • MOTION

        static final java.lang.String MOTION
        The function type is applicable to:
        • BooleanSensor - indicates that the BooleanSensor can detect motion. true state means that there is motion detection. false state means that there is no motion detection.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • HEAT

        static final java.lang.String HEAT
        The function type is applicable to:
        • Meter - indicates that the Meter measures thermal energy provided by a source.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values

      • COLD

        static final java.lang.String COLD
        The function type is applicable to:
        • Meter - indicates that the Meter measures thermal energy provided by a source.
        This type can be specified as a value of Function.SERVICE_TYPE.
        See Also:
        Constant Field Values