javax.telephony.phone
Interface PhoneRinger

All Superinterfaces:

Component

public interface PhoneRinger

extends Component

Phone ringer interface.

Field Summary

static int	FULL Ringer volume definition for the ringer at maximum volume.
static int	MIDDLE Ringer volume definition for the middle volume.
static int	OFF Ringer volume definition for the ringer off.

Method Summary

int	getNumberOfRingPatterns() Returns the number of available ringing patterns.
int	getNumberOfRings() Returns the number of complete ring cycles that the ringer has been ringing.
int	getRingerPattern() Returns the current ringer pattern.
int	getRingerVolume() Returns the current ringer volume.
int	isRingerOn() Returns true if the ringer is on, false otherwise.
void	setRingerPattern(int ringerPattern) Set the ringer pattern given an valid index number returned by getNumberOfRingPatterns().
void	setRingerVolume(int volume) Sets the ringer volume between ZERO or FULL, inclusive.

Methods inherited from interface javax.telephony.phone.Component

getCapabilities, getName

Field Detail

OFF

public static final int OFF

Ringer volume definition for the ringer off.

MIDDLE

public static final int MIDDLE

Ringer volume definition for the middle volume.

FULL

public static final int FULL

Ringer volume definition for the ringer at maximum volume.

Method Detail

isRingerOn

public int isRingerOn()

Returns true if the ringer is on, false otherwise.

Returns:

True if the ringer is on, false otherwise

getRingerVolume

public int getRingerVolume()

Returns the current ringer volume.

Returns:

The current ringer volume.

setRingerVolume

public void setRingerVolume(int volume)
                     throws InvalidArgumentException

Sets the ringer volume between ZERO or FULL, inclusive.

Parameters:

volume - The ringer volume, between ZERO and FULL, inclusive.

Throws:

InvalidArgumentException - The volume provided was not valid.

getRingerPattern

public int getRingerPattern()

Returns the current ringer pattern.

Returns:

The current ringer pattern.

getNumberOfRingPatterns

public int getNumberOfRingPatterns()

Returns the number of available ringing patterns. An index between zero and the returns value minus one may be used for the setRingerPattern() method.

Returns:

The number of available ringer patterns.

setRingerPattern

public void setRingerPattern(int ringerPattern)
                      throws InvalidArgumentException

Set the ringer pattern given an valid index number returned by getNumberOfRingPatterns().

Parameters:

ringerPattern - The desired ringer pattern.

Throws:

InvalidArgumentException - The ring pattern provided was not valid.

getNumberOfRings

public int getNumberOfRings()

Returns the number of complete ring cycles that the ringer has been ringing. A value of 0 indicates that the ringer is not being rung.

Returns:

The current ringer count.