Package org.osgi.service.dal.functions

Interface BooleanControl

All Superinterfaces:

Function

public interface BooleanControl
extends Function

BooleanControl function provides a boolean control support. The eventable function state is accessible with getData() getter and setData(boolean) setter. The state can be reversed with inverse() method, can be set to true value with setTrue() method and can be set to false value with setFalse() method.

The control type can be:

• Types.LIGHT
• Types.DOOR
• Types.WINDOW
• Types.POWER
• other type defined in Types
• custom - vendor specific type

See Also:

• BooleanData

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPERATION_INVERSE	Specifies the inverse operation name.
static final String	OPERATION_SET_FALSE	Specifies the operation name, which sets the control state to false value.
static final String	OPERATION_SET_TRUE	Specifies the operation name, which sets the control state to true value.
static final String	PROPERTY_DATA	Specifies the state 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
BooleanData	getData()	Returns the current state of BooleanControl.
void	inverse()	Reverses the BooleanControl state.
void	setData(boolean data)	Sets the BooleanControl state to the specified value.
void	setFalse()	Sets the BooleanControl state to false value.
void	setTrue()	Sets the BooleanControl state to true value.

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

getOperationMetadata, getPropertyMetadata, getServiceProperty, getServicePropertyKeys

Field Details

OPERATION_INVERSE

static final String OPERATION_INVERSE

Specifies the inverse operation name. The operation can be executed with inverse() method.

See Also:

• Constant Field Values

OPERATION_SET_TRUE

static final String OPERATION_SET_TRUE

Specifies the operation name, which sets the control state to true value. The operation can be executed with setTrue() method.

See Also:

• Constant Field Values

OPERATION_SET_FALSE

static final String OPERATION_SET_FALSE

Specifies the operation name, which sets the control state to false value. The operation can be executed with setFalse() method.

See Also:

• Constant Field Values

PROPERTY_DATA

static final String PROPERTY_DATA

Specifies the state property name. The eventable property value is accessible with getData() method.

See Also:

• BooleanData
• Constant Field Values

Method Details

getData

BooleanData getData()
             throws DeviceException

Returns the current state of BooleanControl. It's a getter method for PROPERTY_DATA property.

Returns:

The current state of BooleanControl.

Throws:

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

DeviceException - If an operation error is available.

See Also:

• BooleanData
• PROPERTY_DATA

setData

void setData(boolean data)
      throws DeviceException

Sets the BooleanControl state to the specified value. It's setter method for PROPERTY_DATA property.

Parameters:

data - The new function value.

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.

See Also:

• PROPERTY_DATA

inverse

void inverse()
      throws DeviceException

Reverses the BooleanControl state. If the current state represents true value, it'll be changed to false. If the current state represents false value, it'll be changed to true. The operation name is OPERATION_INVERSE.

Throws:

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

DeviceException - If an operation error is available.

setTrue

void setTrue()
      throws DeviceException

Sets the BooleanControl state to true value. The operation name is OPERATION_SET_TRUE.

Throws:

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

DeviceException - If an operation error is available.

setFalse

void setFalse()
       throws DeviceException

Sets the BooleanControl state to false value. The operation name is OPERATION_SET_FALSE.

Throws:

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

DeviceException - If an operation error is available.