javax.telephony.phone
Interface PhoneHookswitch

All Superinterfaces:

Component

public interface PhoneHookswitch

extends Component

Phone hook switch interface.

Field Summary

static int	OFF_HOOK The Hookswitch is OFF_HOOK.
static int	ON_HOOK The Hookswitch is ON_HOOK.

Method Summary

int	getHookSwitchState() Returns the current state of the hookswitch.
void	setHookSwitch(int hookSwitchState) Sets the state of the hookswitch to either ON_HOOK or OFF_HOOK.

Methods inherited from interface javax.telephony.phone.Component

getCapabilities, getName

Field Detail

ON_HOOK

public static final int ON_HOOK

The Hookswitch is ON_HOOK.

See Also:

Constant Field Values

OFF_HOOK

public static final int OFF_HOOK

The Hookswitch is OFF_HOOK.

See Also:

Constant Field Values

Method Detail

setHookSwitch

public void setHookSwitch(int hookSwitchState)
                   throws InvalidArgumentException

Sets the state of the hookswitch to either ON_HOOK or OFF_HOOK.

Parameters:

hookSwitchState - The desired state of the hook switch.

Throws:

InvalidArgumentException - The provided hookswitch state is not valid.

getHookSwitchState

public int getHookSwitchState()

Returns the current state of the hookswitch.

Returns:

The current state of the hookswitch.