JSR-043: JTAPI-1.4

javax.telephony.callcontrol
Interface CallControlConnectionEvent

All Superinterfaces:
CallControlCallEvent, CallControlEvent, CallEvent, ConnectionEvent, Event

public interface CallControlConnectionEvent
extends CallControlCallEvent, ConnectionEvent

The CallControlConnectionEvent interface is the base interface for all callcontrol package Connection-related events. All events which pertain to the CallControlConnection interface must extend this interface. This interface extends both the CallControlCallEvent and ConnectionEvent interfaces.

The callcontrol package defines events which are reported when the CallControlConnection state changes. These events have the following IDs: CALLCTL_CONNECTION_ALERTING, CALLCTL_CONNECTION_DIALING, CALLCTL_CONNECTION_DISCONNECTED, CALLCTL_CONNECTION_ESTABLISHED, CALLCTL_CONNECTION_FAILED, CALLCTL_CONNECTION_INITIATED, CALLCTL_CONNECTION_NETWORK_ALERTING, CALLCTL_CONNECTION_NETWORK_REACHED, CALLCTL_CONNECTION_OFFERED, CALLCTL_CONNECTION_QUEUED and CALLCTL_CONNECTION_UNKNOWN.

Each of these events is reported to the corresponding method for an application registered as a CallControlConnectionListener or CallControlTerminalConnectionListener.

Since:
1.4
See Also:
Connection, CallListener, ConnectionEvent, CallControlConnection, CallControlCall, CallControlCallEvent, CallControlCallListener, CallControlConnectionListener, CallControlTerminalConnectionListener

Field Summary
static int CALLCTL_CONNECTION_ALERTING
          The CALLCTL_CONNECTION_ALERTING event indicates that the state of the CallControlConnection object has changed to CallControlConnection.ALERTING.
static int CALLCTL_CONNECTION_DIALING
          The CALLCTL_CONNECTION_DIALING event indicates that the state of the CallControlConnection object has changed to CallControlConnection.DIALING.
static int CALLCTL_CONNECTION_DISCONNECTED
          The CALLCTL_CONNECTION_DISCONNECTED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.DISCONNECTED.
static int CALLCTL_CONNECTION_ESTABLISHED
          The CALLCTL_CONNECTION_ESTABLISHED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.ESTABLISHED.
static int CALLCTL_CONNECTION_FAILED
          The CALLCTL_CONNECTION_FAILED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.FAILED.
static int CALLCTL_CONNECTION_INITIATED
          The CALLCTL_CONNECTION_INITIATED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.INITIATED.
static int CALLCTL_CONNECTION_NETWORK_ALERTING
          The CALLCTL_CONNECTION_NETWORK_ALERTING event indicates that the state of the CallControlConnection object has changed to CallControlConnection.NETWORK_ALERTING.
static int CALLCTL_CONNECTION_NETWORK_REACHED
          The CALLCTL_CONNECTION_NETWORK_REACHED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.NETWORK_REACHED.
static int CALLCTL_CONNECTION_OFFERED
          The CALLCTL_CONNECTION_OFFERED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.OFFERED.
static int CALLCTL_CONNECTION_QUEUED
          The CALLCTL_CONNECTION_QUEUED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.QUEUED.
static int CALLCTL_CONNECTION_UNKNOWN
          The CALLCTL_CONNECTION_UNKNOWN event indicates that the state of the CallControlConnection object has changed to CallControlConnection.UNKNOWN.
 
Fields inherited from interface javax.telephony.callcontrol.CallControlEvent
CAUSE_ALTERNATE, CAUSE_BUSY, CAUSE_CALL_BACK, CAUSE_CALL_NOT_ANSWERED, CAUSE_CALL_PICKUP, CAUSE_CONFERENCE, CAUSE_DO_NOT_DISTURB, CAUSE_PARK, CAUSE_REDIRECTED, CAUSE_REORDER_TONE, CAUSE_TRANSFER, CAUSE_TRUNKS_BUSY, CAUSE_UNHOLD
 
Fields inherited from interface javax.telephony.Event
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN
 
Fields inherited from interface javax.telephony.CallEvent
CALL_ACTIVE, CALL_EVENT_TRANSMISSION_ENDED, CALL_INVALID
 
Fields inherited from interface javax.telephony.ConnectionEvent
CONNECTION_ALERTING, CONNECTION_CONNECTED, CONNECTION_CREATED, CONNECTION_DISCONNECTED, CONNECTION_FAILED, CONNECTION_IN_PROGRESS, CONNECTION_UNKNOWN
 
Method Summary
 java.lang.String getDigits()
          Returns the digits that have already been dialed.
 int getNumberInQueue()
          Returns the number of Connections which are queued at the Address of this Connection.
 
Methods inherited from interface javax.telephony.callcontrol.CallControlCallEvent
getCalledAddress, getCallingAddress, getCallingTerminal, getLastRedirectedAddress
 
Methods inherited from interface javax.telephony.callcontrol.CallControlEvent
getCallControlCause
 
Methods inherited from interface javax.telephony.Event
getCause, getID, getMetaEvent, getSource
 
Methods inherited from interface javax.telephony.CallEvent
getCall
 
Methods inherited from interface javax.telephony.ConnectionEvent
getConnection
 

Field Detail

CALLCTL_CONNECTION_ALERTING

public static final int CALLCTL_CONNECTION_ALERTING
The CALLCTL_CONNECTION_ALERTING event indicates that the state of the CallControlConnection object has changed to CallControlConnection.ALERTING.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionAlerting( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_DIALING

public static final int CALLCTL_CONNECTION_DIALING
The CALLCTL_CONNECTION_DIALING event indicates that the state of the CallControlConnection object has changed to CallControlConnection.DIALING.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionDialing( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_DISCONNECTED

public static final int CALLCTL_CONNECTION_DISCONNECTED
The CALLCTL_CONNECTION_DISCONNECTED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.DISCONNECTED.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionDisconnected( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_ESTABLISHED

public static final int CALLCTL_CONNECTION_ESTABLISHED
The CALLCTL_CONNECTION_ESTABLISHED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.ESTABLISHED.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionEstablished( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_FAILED

public static final int CALLCTL_CONNECTION_FAILED
The CALLCTL_CONNECTION_FAILED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.FAILED.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionFailed( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_INITIATED

public static final int CALLCTL_CONNECTION_INITIATED
The CALLCTL_CONNECTION_INITIATED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.INITIATED.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionInitiated( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_NETWORK_ALERTING

public static final int CALLCTL_CONNECTION_NETWORK_ALERTING
The CALLCTL_CONNECTION_NETWORK_ALERTING event indicates that the state of the CallControlConnection object has changed to CallControlConnection.NETWORK_ALERTING.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionNetworkAlerting( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_NETWORK_REACHED

public static final int CALLCTL_CONNECTION_NETWORK_REACHED
The CALLCTL_CONNECTION_NETWORK_REACHED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.NETWORK_REACHED.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionNetworkReached( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_OFFERED

public static final int CALLCTL_CONNECTION_OFFERED
The CALLCTL_CONNECTION_OFFERED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.OFFERED.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionOffered( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_QUEUED

public static final int CALLCTL_CONNECTION_QUEUED
The CALLCTL_CONNECTION_QUEUED event indicates that the state of the CallControlConnection object has changed to CallControlConnection.QUEUED.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionQueued( CallControlConnectionEvent ) method.


CALLCTL_CONNECTION_UNKNOWN

public static final int CALLCTL_CONNECTION_UNKNOWN
The CALLCTL_CONNECTION_UNKNOWN event indicates that the state of the CallControlConnection object has changed to CallControlConnection.UNKNOWN.

This constant indicates a specific event passed via the CallControlConnectionEvent event, and is reported on the CallControlCallListener interface by calling the CallControlConnectionListener.connectionUnknown( CallControlConnectionEvent ) method.

Method Detail

getDigits

public java.lang.String getDigits()
Returns the digits that have already been dialed.

Returns:
The digits that have already been dialed.

getNumberInQueue

public int getNumberInQueue()
Returns the number of Connections which are queued at the Address of this Connection.

Returns:
The number of queued Connections.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org