Package org.osgi.service.dal.functions

Interface MultiLevelControl

All Superinterfaces:

Function

public interface MultiLevelControl
extends Function

MultiLevelControl function provides multi-level control support. The eventable function level is accessible with getData() getter and setData(BigDecimal, String) setter.

The control type can be:

• Types.LIGHT
• Types.TEMPERATURE
• Types.FLOW
• Types.PRESSURE
• Types.HUMIDITY
• Types.GAS
• Types.SMOKE
• Types.DOOR
• Types.WINDOW
• Types.LIQUID
• Types.POWER
• Types.NOISINESS
• other type defined in Types
• custom - vendor specific type

See Also:

• LevelData

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_DATA	Specifies the level property name.

Fields inherited from interface org.osgi.service.dal.Function

SERVICE_DESCRIPTION, SERVICE_DEVICE_UID, SERVICE_OPERATION_NAMES, SERVICE_PROPERTY_NAMES, SERVICE_REFERENCE_UIDS, SERVICE_TYPE, SERVICE_UID, SERVICE_VERSION

Method Summary

Modifier and Type	Method	Description
LevelData	getData()	Returns MultiLevelControl level.
void	setData(BigDecimal level, String unit)	Sets MultiLevelControl level according to the specified unit.

Methods inherited from interface org.osgi.service.dal.Function

getOperationMetadata, getPropertyMetadata, getServiceProperty, getServicePropertyKeys

Field Details

PROPERTY_DATA

static final String PROPERTY_DATA

Specifies the level property name. The eventable property can be read with getData() getter and can be set with setData(BigDecimal, String) setters.

See Also:

• Constant Field Values

Method Details

getData

LevelData getData()
           throws DeviceException

Returns MultiLevelControl level. It's a getter method for PROPERTY_DATA property.

Returns:

MultiLevelControl level.

Throws:

IllegalStateException - If this function service object has already been unregistered.

DeviceException - If an operation error is available.

See Also:

• LevelData

setData

void setData(BigDecimal level,
 String unit)
      throws DeviceException

Sets MultiLevelControl level according to the specified unit. It's a setter method for PROPERTY_DATA property.

Parameters:

level - The new control level.

unit - The level unit.

Throws:

IllegalStateException - If this function service object has already been unregistered.

DeviceException - If an operation error is available.

IllegalArgumentException - If there is an invalid argument.