org.eclipse.ecf.telephony.call
Class CallSessionState

java.lang.Object
  org.eclipse.ecf.telephony.call.CallSessionState

All Implemented Interfaces:

java.io.Serializable

public class CallSessionState
extends java.lang.Object
implements java.io.Serializable

Type-safe enumeration class to represent call session state information. See ICallSession.getState().

See Also:

Serialized Form

Field Summary

static CallSessionState	ACTIVE For calls where the call has been successfully answered and the parties are speaking.
protected static java.lang.String	ACTIVE_NAME
static CallSessionState	BUSY For calls where the receiver of the call request is busy and not able to answer the call.
protected static java.lang.String	BUSY_NAME
static CallSessionState	CANCELLED For calls where the initial requester has cancelled the call request.
protected static java.lang.String	CANCELLED_NAME
static CallSessionState	ERROR For calls where there has been an error, resulting in loss of connection.
protected static java.lang.String	ERROR_NAME
static CallSessionState	FAILED For calls where the call has failed, either due to network error, sender and/or receiver going offline, or some other failure to deliver or answer a call request.
protected static java.lang.String	FAILED_NAME
static CallSessionState	FINISHED To indicate that the call (previously ACTIVE) is now finished.
protected static java.lang.String	FINISHED_NAME
static CallSessionState	MISSED To indicate that a call request has been missed (the receiver did not answer in time).
protected static java.lang.String	MISSED_NAME
static CallSessionState	ONHOLD For calls that have been put on hold by one of the two parties.
protected static java.lang.String	ONHOLD_NAME
static CallSessionState	PENDING For a call where the request has been received, and the receiver has not yet responded to the request.
protected static java.lang.String	PENDING_NAME
static CallSessionState	PREPENDING To indicate that the call request has not yet been delivered to the receiver (which results in a PENDING state), but has completed routing.
protected static java.lang.String	PREPENDING_NAME
static CallSessionState	REDIRECTED For calls that have been redirected to a new target receiver.
protected static java.lang.String	REDIRECTED_NAME
static CallSessionState	REFUSED To indicate that a call request has been explicitly refused by the receiver.
protected static java.lang.String	REFUSED_NAME
static CallSessionState	ROUTING For calls where the routing is in progress, and the target has not yet received the request.
protected static java.lang.String	ROUTING_NAME
protected static long	serialVersionUID
static CallSessionState	UNKNOWN For calls where the state is not known.
protected static java.lang.String	UNKNOWN_NAME
static CallSessionState	UNPLACED For calls where the request has not yet been sent to the target receiver.
protected static java.lang.String	UNPLACED_NAME

Constructor Summary

protected

CallSessionState(java.lang.String name)

Method Summary

boolean	equals(java.lang.Object that)
static CallSessionState	fromString(java.lang.String state)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

UNPLACED_NAME

protected static final java.lang.String UNPLACED_NAME

See Also:

Constant Field Values

REDIRECTED_NAME

protected static final java.lang.String REDIRECTED_NAME

See Also:

Constant Field Values

ROUTING_NAME

protected static final java.lang.String ROUTING_NAME

See Also:

Constant Field Values

PREPENDING_NAME

protected static final java.lang.String PREPENDING_NAME

See Also:

Constant Field Values

FAILED_NAME

protected static final java.lang.String FAILED_NAME

See Also:

Constant Field Values

PENDING_NAME

protected static final java.lang.String PENDING_NAME

See Also:

Constant Field Values

ACTIVE_NAME

protected static final java.lang.String ACTIVE_NAME

See Also:

Constant Field Values

ONHOLD_NAME

protected static final java.lang.String ONHOLD_NAME

See Also:

Constant Field Values

FINISHED_NAME

protected static final java.lang.String FINISHED_NAME

See Also:

Constant Field Values

MISSED_NAME

protected static final java.lang.String MISSED_NAME

See Also:

Constant Field Values

REFUSED_NAME

protected static final java.lang.String REFUSED_NAME

See Also:

Constant Field Values

BUSY_NAME

protected static final java.lang.String BUSY_NAME

See Also:

Constant Field Values

CANCELLED_NAME

protected static final java.lang.String CANCELLED_NAME

See Also:

Constant Field Values

UNKNOWN_NAME

protected static final java.lang.String UNKNOWN_NAME

See Also:

Constant Field Values

ERROR_NAME

protected static final java.lang.String ERROR_NAME

See Also:

Constant Field Values

UNPLACED

public static final CallSessionState UNPLACED

For calls where the request has not yet been sent to the target receiver.

REDIRECTED

public static final CallSessionState REDIRECTED

For calls that have been redirected to a new target receiver.

ROUTING

public static final CallSessionState ROUTING

For calls where the routing is in progress, and the target has not yet received the request.

PREPENDING

public static final CallSessionState PREPENDING

To indicate that the call request has not yet been delivered to the receiver (which results in a PENDING state), but has completed routing.

FAILED

public static final CallSessionState FAILED

For calls where the call has failed, either due to network error, sender and/or receiver going offline, or some other failure to deliver or answer a call request.

PENDING

public static final CallSessionState PENDING

For a call where the request has been received, and the receiver has not yet responded to the request. Also known as 'ringing'.

ACTIVE

public static final CallSessionState ACTIVE

For calls where the call has been successfully answered and the parties are speaking.

ONHOLD

public static final CallSessionState ONHOLD

For calls that have been put on hold by one of the two parties.

FINISHED

public static final CallSessionState FINISHED

To indicate that the call (previously ACTIVE) is now finished. This state can be reached by either partie(s) ending the call in a normal manner (e.g. hangup).

MISSED

public static final CallSessionState MISSED

To indicate that a call request has been missed (the receiver did not answer in time).

REFUSED

public static final CallSessionState REFUSED

To indicate that a call request has been explicitly refused by the receiver.

BUSY

public static final CallSessionState BUSY

For calls where the receiver of the call request is busy and not able to answer the call.

CANCELLED

public static final CallSessionState CANCELLED

For calls where the initial requester has cancelled the call request.

UNKNOWN

public static final CallSessionState UNKNOWN

For calls where the state is not known.

ERROR

public static final CallSessionState ERROR

For calls where there has been an error, resulting in loss of connection.

Constructor Detail

CallSessionState

protected CallSessionState(java.lang.String name)

Method Detail

fromString

public static CallSessionState fromString(java.lang.String state)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public final boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object