com.avaya.jtapi.tsapi
Interface LucentV5Connection

All Superinterfaces:

CallControlConnection, Connection, ITsapiConnection, LucentConnection

All Known Subinterfaces:

LucentV6Connection

public interface LucentV5Connection

extends LucentConnection

The LucentV5Connection interface extends LucentConnection with features specific to DEFINITY G3 PBX Driver Version 5 private data. When a Provider is bound to a DEFINITY switch which supports V5 private data, this interface may be used to access additional capabilities.

The Selective Listening service allows an application to prevent a specific party on a call from hearing anything said by another specific party (or all other parties) on the call. It allows an application to put a non-bridged Connection's listening path on listen-hold with respect to a selected TerminalConnection or non-bridged Connection (partyToHold), or to all other parties. The selected party(s) may be stations or trunks. A party that has been listen-held may continue to talk and be heard by other connected parties on the call since this service does not affect the talking or listening path of any other party. A party will be able to hear parties on the call from which it has not been listen-held, but will not be able to hear any party from which it has been listen-held. This service will also allow the listen-held party to be unheld (i.e., to again hear the other party(s) on the call).

The Selective Listening service is also available on LucentV5TerminalConnection.

Field Summary

Fields inherited from interface com.avaya.jtapi.tsapi.LucentConnection

DR_CALL_CLASSIFIER, DR_NONE, DR_TONE_GENERATOR

Fields inherited from interface javax.telephony.Connection

ALERTING, CONNECTED, DISCONNECTED, FAILED, IDLE, INPROGRESS, UNKNOWN

Fields inherited from interface javax.telephony.callcontrol.CallControlConnection

ALERTING, DIALING, DISCONNECTED, ESTABLISHED, FAILED, IDLE, INITIATED, NETWORK_ALERTING, NETWORK_REACHED, OFFERED, OFFERING, QUEUED, UNKNOWN

Method Summary

void	listenHold(LucentConnection partyToHold) Places a non-bridged Connection's listening path on listen-hold with respect to the specified non-bridged Connection.
void	listenHold(LucentTerminalConnection partyToHold) Places a non-bridged Connection's listening path on listen-hold with respect to the specified TerminalConnection.
void	listenUnhold(LucentConnection partyToUnhold) Takes a non-bridged Connection's listening path off listen-hold with respect to the specified non-bridged Connection.
void	listenUnhold(LucentTerminalConnection partyToUnhold) Takes a non-bridged Connection's listening path off listen-hold with respect to the specified TerminalConnection.

Methods inherited from interface com.avaya.jtapi.tsapi.LucentConnection

disconnect

Methods inherited from interface javax.telephony.Connection

disconnect, getAddress, getCall, getCapabilities, getConnectionCapabilities, getState, getTerminalConnections

Methods inherited from interface javax.telephony.callcontrol.CallControlConnection

accept, addToAddress, getCallControlState, park, redirect, reject

Method Detail

listenHold

public void listenHold(LucentTerminalConnection partyToHold)
                throws TsapiInvalidStateException,
                       TsapiMethodNotSupportedException,
                       TsapiPrivilegeViolationException,
                       TsapiResourceUnavailableException,
                       TsapiInvalidArgumentException

Places a non-bridged Connection's listening path on listen-hold with respect to the specified TerminalConnection. If partyToHold is null, the operation applies to all other parties on the call. If the Connection has multiple TerminalConnections, a TsapiInvalidArgumentException is thrown; in this case, use a TerminalConnection instead.

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

TsapiInvalidArgumentException

listenUnhold

public void listenUnhold(LucentTerminalConnection partyToUnhold)
                  throws TsapiInvalidStateException,
                         TsapiMethodNotSupportedException,
                         TsapiPrivilegeViolationException,
                         TsapiResourceUnavailableException,
                         TsapiInvalidArgumentException

Takes a non-bridged Connection's listening path off listen-hold with respect to the specified TerminalConnection. If partyToUnhold is null, the operation applies to all other parties on the call. If the Connection has multiple TerminalConnections, a TsapiInvalidArgumentException is thrown; in this case, use a TerminalConnection instead.

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

TsapiInvalidArgumentException

listenHold

public void listenHold(LucentConnection partyToHold)
                throws TsapiInvalidStateException,
                       TsapiMethodNotSupportedException,
                       TsapiPrivilegeViolationException,
                       TsapiResourceUnavailableException,
                       TsapiInvalidArgumentException

Places a non-bridged Connection's listening path on listen-hold with respect to the specified non-bridged Connection. If partyToHold is null, the operation applies to all other parties on the call. If either Connection has multiple TerminalConnections, a TsapiInvalidArgumentException is thrown; in this case, use a TerminalConnection instead.

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

TsapiInvalidArgumentException

listenUnhold

public void listenUnhold(LucentConnection partyToUnhold)
                  throws TsapiInvalidStateException,
                         TsapiMethodNotSupportedException,
                         TsapiPrivilegeViolationException,
                         TsapiResourceUnavailableException,
                         TsapiInvalidArgumentException

Takes a non-bridged Connection's listening path off listen-hold with respect to the specified non-bridged Connection. If partyToUnhold is null, the operation applies to all other parties on the call. If either Connection has multiple TerminalConnections, a TsapiInvalidArgumentException is thrown; in this case, use a TerminalConnection instead.

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

TsapiInvalidArgumentException