org.osgi.service.dal.functions

public Interface MultiLevelControl

Imports: java.math.BigDecimal, org.osgi.service.dal.DeviceException, .Function, org.osgi.service.dal.functions.data.LevelData

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:

See Also: LevelData

Field Summary

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

Inherited from 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 and Description
public LevelData	Returns: `MultiLevelControl` level. getData() Returns `MultiLevelControl` level.
public void	setData(BigDecimal The new control level. level, String The level unit. unit) Sets `MultiLevelControl` level according to the specified unit.

Inherited from org.osgi.service.dal.Function:: getOperationMetadata getPropertyMetadata getServiceProperty getServicePropertyKeys

Field Detail

PROPERTY_DATA	back to summary
public 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.

Method Detail

getData back to summary

getData	back to summary
public LevelData getData() throws DeviceException Returns `MultiLevelControl` level. It's a getter method for `PROPERTY_DATA` property. Returns:LevelData `MultiLevelControl` level. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered. See Also `LevelData`

public LevelData getData() throws DeviceException

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

Returns:LevelData

MultiLevelControl level.

Exceptions

DeviceException:: If an operation error is available.
IllegalStateException:: If this function service object has already been unregistered.

See Also

LevelData

setData back to summary

setData	back to summary
public 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:BigDecimal The new control level. unit:String The level unit. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered. IllegalArgumentException: If there is an invalid argument.

public 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:BigDecimal: The new control level.
unit:String: The level unit.

Exceptions

DeviceException:: If an operation error is available.
IllegalStateException:: If this function service object has already been unregistered.
IllegalArgumentException:: If there is an invalid argument.