OpenScape
V3.2, Revision 044 20100322

com.siemens.symphonia.bcom.bcommon.external
Interface ConnectionState

All Known Implementing Classes:
ConnectionState

public interface ConnectionState

Defines the state of a ComConnection object.

The current state of a ComConnection object represents the present situation of the communication link.
All state changes are notified by a ConnectionListener events with the corresponding method name.

Note: Java 1.5 enum types are not used because Java 1.4 compatibility is a requirement.


Field Summary
static ConnectionState ALERTING
          Ring tone being applied for target.
static ConnectionState BUSY
          Communication target is busy.
static ConnectionState CONNECTED
          Communication is connected.
static ConnectionState DIALTONE
          Dial tone being applied.
static ConnectionState FAILED
          Communication target failed.
static ConnectionState HELD
          Connection is in call hold.
static ConnectionState INITIATED
          Connection establishment initiated.
static ConnectionState OFFERED
          Call routing is ongoing.
static ConnectionState RINGBACK
          Ring tone being applied for initiator.
static ConnectionState TERMINATED
          Connection is terminated.
static ConnectionState TRANSFER_PENDING
          Reconnect option is available.
static ConnectionState UNKNOWN
          State not known.
 
Method Summary
 boolean compareState(ConnectionState callState)
          Compares connection state.
 

Field Detail

UNKNOWN

static final ConnectionState UNKNOWN
State not known.

Immediatelly after creating or terminating a ComConnection the state is not known. This state could therefore considered to be an initial or final state. For this reason there is no explicit ConnectionListener event.


DIALTONE

static final ConnectionState DIALTONE
Dial tone being applied.

In case of a physical telephone device represented by the ComConnection object a dial tone can be heard.

Note: this state applies only to outbound communications.


INITIATED

static final ConnectionState INITIATED
Connection establishment initiated.

A request to establish a connection is setup and processing is started.

Note: this state applies only to outbound communications.


RINGBACK

static final ConnectionState RINGBACK
Ring tone being applied for initiator.

In case of a physical telephone device represented by the ComConnection object a ring tone can be heard by the initiator of the communication. The target of the communication is being alerted.

Note: this state applies only to outbound communications.


ALERTING

static final ConnectionState ALERTING
Ring tone being applied for target.

In case of a physical telephone device represented by the ComConnection object the device is ringing.

Note: this state applies only to inbound communications.


CONNECTED

static final ConnectionState CONNECTED
Communication is connected.

The ComConnection object is part of a connected communication. I.e. all participants can communicate to each other. This holds as well for a normal two party communication as for a conference.


HELD

static final ConnectionState HELD
Connection is in call hold.

The concerned party represented by the ComConnection object is temporary not part of a connected communication. It can be retrieved to take part again.
A typical example is when the communication partner want's to consult another party, the original communication partner is placed in call hold.


BUSY

static final ConnectionState BUSY
Communication target is busy.

A communication requst failed because the communication partner is currently busy.

Note: this state applies only to inbound communications.


FAILED

static final ConnectionState FAILED
Communication target failed.

A communication requst failed for a reason other than the target being busy. The method getFailedReason() can be used to get more detail of the failure.

Note: this state applies only to inbound communications.


TERMINATED

static final ConnectionState TERMINATED
Connection is terminated.

The ComConnection object reached end of life. Any involvement in a communication is completed.

Note: this is the final state.


OFFERED

static final ConnectionState OFFERED
Call routing is ongoing.

This is a special state intended only for call routing services. Contrary to all other events notification is done by means of the RoutingListener interface.

Note: this state applies only to inbound communications.


TRANSFER_PENDING

static final ConnectionState TRANSFER_PENDING
Reconnect option is available.

Under certain circumstances (e.g. during a blind transfer) it is possible that a transferred communication is sent back to the transferring party because the transfer target doesn't answer the communication (or is busy). This state indicates that this option is currently available.
When the transfer completes the state changes to TERMINATED. It is also possible that the reconnect itself fails which results in a state change to BUSY or FAILED.

Method Detail

compareState

boolean compareState(ConnectionState callState)
Compares connection state.

A type-safe implementation for comparing the state of the ComConnection object with a given ConnectionState.

Parameters:
callState - the state to compare with.
Returns:
true, if the states are equal, otherwise false.

OpenScape
V3.2, Revision 044 20100322

Copyright (c) 2007 Siemens Enterprise Communications, Germany
All rights reserved.

This software is the confidential and proprietary information of Siemens Enterprise Communications, Germany