javax.telephony.phone
Interface PhoneLamp

All Superinterfaces:

Component

public interface PhoneLamp
extends Component

Phone lamp interface.

Field Summary

static int	LAMPMODE_BROKENFLUTTER The lamp mode is BROKENFLUTTER, which is the superposition of flash and flutter.
static int	LAMPMODE_FLASH The lamp mode is FLASH, which means slow on and off.
static int	LAMPMODE_FLUTTER The lamp mode is FLUUTER, which means fast on and off.
static int	LAMPMODE_OFF The lamp mode is OFF.
static int	LAMPMODE_STEADY The lamp is STEADY, which means continuously lit.
static int	LAMPMODE_WINK The lamp mode is WINK.

Method Summary

PhoneButton	getAssociatedPhoneButton() Returns the button associated with the lamp.
int	getMode() Returns the current lamp mode.
int[]	getSupportedModes() Returns an array of supported lamp modes.
void	setMode(int mode) Sets the current lamp mode to a mode supported by the lamp and returns by getSupportedModes().

Methods inherited from interface javax.telephony.phone.Component

getCapabilities, getName

Field Detail

LAMPMODE_OFF

static final int LAMPMODE_OFF

The lamp mode is OFF.

See Also:

Constant Field Values

LAMPMODE_FLASH

static final int LAMPMODE_FLASH

The lamp mode is FLASH, which means slow on and off.

See Also:

Constant Field Values

LAMPMODE_STEADY

static final int LAMPMODE_STEADY

The lamp is STEADY, which means continuously lit.

See Also:

Constant Field Values

LAMPMODE_FLUTTER

static final int LAMPMODE_FLUTTER

The lamp mode is FLUUTER, which means fast on and off.

See Also:

Constant Field Values

LAMPMODE_BROKENFLUTTER

static final int LAMPMODE_BROKENFLUTTER

The lamp mode is BROKENFLUTTER, which is the superposition of flash and flutter.

See Also:

Constant Field Values

LAMPMODE_WINK

static final int LAMPMODE_WINK

The lamp mode is WINK.

See Also:

Constant Field Values

Method Detail

getSupportedModes

int[] getSupportedModes()

Returns an array of supported lamp modes.

Returns:

An array of supported lamp modes.

setMode

void setMode(int mode)
             throws InvalidArgumentException

Sets the current lamp mode to a mode supported by the lamp and returns by getSupportedModes().

Parameters:

mode - The desired lamp mode.

Throws:

InvalidArgumentException - The provided lamp mode is not valid.

getMode

int getMode()

Returns the current lamp mode.

Returns:

The current lamp mode.

getAssociatedPhoneButton

PhoneButton getAssociatedPhoneButton()

Returns the button associated with the lamp.

Returns:

The button associated with the lamp.