javax.telephony.callcontrol
Interface CallControlEvent

All Superinterfaces:

Event

All Known Subinterfaces:

CallControlAddressEvent, CallControlCallEvent, CallControlConnectionEvent, CallControlTerminalConnectionEvent, CallControlTerminalEvent

public interface CallControlEvent

extends Event

The CallControlEvent is the base event for all events in the callcontrol package. Each event in this package extends this interface. This interface extends the core Event interface.

This interface contains the getCallControlCause() method which returns a call control package specific cause for the event. Cause codes pertaining to this package are defined in this interface as well.

This interface is extended by the following interfaces: CallControlCallEvent, CallControlAddressEvent, and CallControlTerminalEvent.

Since:

1.4

See Also:

Event, CallControlCallEvent, CallControlAddressEvent, CallControlTerminalEvent

Field Summary

static int	CAUSE_ALTERNATE Cause code indicating that the call was put on hold and another retrieved in an atomic operation, typically on single line telephones.
static int	CAUSE_BUSY Cause code indicating that the call encountered a busy endpoint.
static int	CAUSE_CALL_BACK Cause code indicating the event is related to the callback feature.
static int	CAUSE_CALL_NOT_ANSWERED Cause code indicating that the call was not answered before a timer elapsed.
static int	CAUSE_CALL_PICKUP Cause code indicating that the call was redirected by the call pickup feature.
static int	CAUSE_CONFERENCE Cause code indicating the event is related to the conference feature.
static int	CAUSE_DO_NOT_DISTURB Cause code indicating the event is related to the do not disturb feature.
static int	CAUSE_PARK Cause code indicating the event is related to the park feature.
static int	CAUSE_REDIRECTED Cause code indicating the event is related to the redirect feature.
static int	CAUSE_REORDER_TONE Cause code indicating that the call encountered a reorder tone.
static int	CAUSE_TRANSFER Cause code indicating the event is related to the transfer feature.
static int	CAUSE_TRUNKS_BUSY Cause code indicating that the call encountered the "all trunks busy" condition.
static int	CAUSE_UNHOLD Cause code indicating the event is related to the unhold feature.

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

Method Summary

int	getCallControlCause() Returns the call control package cause associated with the event.

Methods inherited from interface javax.telephony.Event

getCause, getID, getMetaEvent, getSource

Field Detail

CAUSE_ALTERNATE

public static final int CAUSE_ALTERNATE

Cause code indicating that the call was put on hold and another retrieved in an atomic operation, typically on single line telephones.

CAUSE_BUSY

public static final int CAUSE_BUSY

Cause code indicating that the call encountered a busy endpoint.

CAUSE_CALL_BACK

public static final int CAUSE_CALL_BACK

Cause code indicating the event is related to the callback feature.

CAUSE_CALL_NOT_ANSWERED

public static final int CAUSE_CALL_NOT_ANSWERED

Cause code indicating that the call was not answered before a timer elapsed.

CAUSE_CALL_PICKUP

public static final int CAUSE_CALL_PICKUP

Cause code indicating that the call was redirected by the call pickup feature.

CAUSE_CONFERENCE

public static final int CAUSE_CONFERENCE

Cause code indicating the event is related to the conference feature.

CAUSE_DO_NOT_DISTURB

public static final int CAUSE_DO_NOT_DISTURB

Cause code indicating the event is related to the do not disturb feature.

CAUSE_PARK

public static final int CAUSE_PARK

Cause code indicating the event is related to the park feature.

CAUSE_REDIRECTED

public static final int CAUSE_REDIRECTED

Cause code indicating the event is related to the redirect feature.

CAUSE_REORDER_TONE

public static final int CAUSE_REORDER_TONE

Cause code indicating that the call encountered a reorder tone.

CAUSE_TRANSFER

public static final int CAUSE_TRANSFER

Cause code indicating the event is related to the transfer feature.

CAUSE_TRUNKS_BUSY

public static final int CAUSE_TRUNKS_BUSY

Cause code indicating that the call encountered the "all trunks busy" condition.

CAUSE_UNHOLD

public static final int CAUSE_UNHOLD

Cause code indicating the event is related to the unhold feature.

Method Detail

getCallControlCause

public int getCallControlCause()

Returns the call control package cause associated with the event. The cause values are integer constants defined in this interface. This method may also returns the Event.CAUSE_NORMAL and the Event.CAUSE_UNKNOWN values as defined in the core package.

Returns:

The call control package cause of the event.