javax.telephony.callcontrol.events
Interface CallCtlEv

All Superinterfaces:

Ev

All Known Subinterfaces:

CallCtlAddrDoNotDisturbEv, CallCtlAddrEv, CallCtlAddrForwardEv, CallCtlAddrMessageWaitingEv, CallCtlCallEv, CallCtlConnAlertingEv, CallCtlConnDialingEv, CallCtlConnDisconnectedEv, CallCtlConnEstablishedEv, CallCtlConnEv, CallCtlConnFailedEv, CallCtlConnInitiatedEv, CallCtlConnNetworkAlertingEv, CallCtlConnNetworkReachedEv, CallCtlConnOfferedEv, CallCtlConnQueuedEv, CallCtlConnUnknownEv, CallCtlTermConnBridgedEv, CallCtlTermConnDroppedEv, CallCtlTermConnEv, CallCtlTermConnHeldEv, CallCtlTermConnInUseEv, CallCtlTermConnRingingEv, CallCtlTermConnTalkingEv, CallCtlTermConnUnknownEv, CallCtlTermDoNotDisturbEv, CallCtlTermEv, ITsapiAddressMsgWaitingEvent, ITsapiConnNetworkReachedEvent, LucentAddressMsgWaitingEvent, LucentConnNetworkReachedEvent

public interface CallCtlEv

extends Ev

The CallCtlEv is the base event for all events in the call control package. Each event in this package must extend this interface. This interface extends the core Ev 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.

In the call control package, this interface is extended by the following interfaces: CallCtlCallEv, CallCtlAddrEv, and CallCtlTermEv.

Avaya is providing its backward-compatible Observer model implementation in this release; in the specification this interface is deprecated as of JTAPI 1.4, replaced by CallControlEvent

See Also:

Ev, CallCtlCallEv, CallCtlAddrEv, CallCtlTermEv

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.events.Ev

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, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN

Method Summary

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

Methods inherited from interface javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

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.

See Also:

Constant Field Values

CAUSE_BUSY

public static final int CAUSE_BUSY

Cause code indicating that the call encountered a busy endpoint.

See Also:

Constant Field Values

CAUSE_CALL_BACK

public static final int CAUSE_CALL_BACK

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

See Also:

Constant Field Values

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.

See Also:

Constant Field Values

CAUSE_CALL_PICKUP

public static final int CAUSE_CALL_PICKUP

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

See Also:

Constant Field Values

CAUSE_CONFERENCE

public static final int CAUSE_CONFERENCE

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

See Also:

Constant Field Values

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.

See Also:

Constant Field Values

CAUSE_PARK

public static final int CAUSE_PARK

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

See Also:

Constant Field Values

CAUSE_REDIRECTED

public static final int CAUSE_REDIRECTED

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

See Also:

Constant Field Values

CAUSE_REORDER_TONE

public static final int CAUSE_REORDER_TONE

Cause code indicating that the call encountered a reorder tone.

See Also:

Constant Field Values

CAUSE_TRANSFER

public static final int CAUSE_TRANSFER

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

See Also:

Constant Field Values

CAUSE_TRUNKS_BUSY

public static final int CAUSE_TRUNKS_BUSY

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

See Also:

Constant Field Values

CAUSE_UNHOLD

public static final int CAUSE_UNHOLD

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

See Also:

Constant Field Values

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 Ev.CAUSE_NORMAL and the Ev.CAUSE_UNKNOWN values as defined in the core package.

Returns:

The call control package cause of the event.