jain.jcp
Interface Event

All Known Subinterfaces:
CallLoadControlEvent, JccCallEvent, JccConnectionEvent, JcpCallEvent, JcpConnectionEvent, JcpProviderEvent

public interface Event

The Event interface is the parent of all JCC and JCP Event interfaces. Event interfaces within each package are organized in a hierarchical fashion.

Event objects correspond to the object which is undergoing a state change; the specific state change is conveyed to the application in two ways.

First, the implementation reports the event to a particular method in a particular Listener interface to a listening object; generally the method corresponds to a particular state change.

Second, the event that is presented to the method has an identification integer which indicates the specific state change. The Event.getID() method returns this identification number for each event. The actual event identification integer values that may be conveyed by the individual event object are defined in each of the specific event interfaces.

Each event caries a cause or a reason why the event happened. The getCause() method returns this cause value. The different types of cause values are also defined in this interface.


Field Summary
static int CAUSE_CALL_CANCELLED
          Cause code indicating the user has terminated call without going on-hook.
static int CAUSE_DEST_NOT_OBTAINABLE
          Cause code indicating the destination is not available.
static int CAUSE_INCOMPATIBLE_DESTINATION
          Cause code indicating that a call has encountered an incompatible destination.
static int CAUSE_LOCKOUT
          Cause code indicating that a call has encountered an inter-digit timeout while dialing.
static int CAUSE_NETWORK_CONGESTION
          Cause code indicating that a call has encountered network congestion.
static int CAUSE_NETWORK_NOT_OBTAINABLE
          Cause code indicating that a call could not reach a destination network.
static int CAUSE_NEW_CALL
          Cause code indicating a new call.
static int CAUSE_NORMAL
          Cause code indicating a normal operation.
static int CAUSE_REDIRECTED
          Cause code indicating the cause was because of call being redirected.
static int CAUSE_RESOURCES_NOT_AVAILABLE
          Cause code indicating that resources were not available.
static int CAUSE_SNAPSHOT
          Cause code indicating that the event is part of a snapshot of the current state of the call.
static int CAUSE_UNKNOWN
          Cause code indicating the cause was unknown.
 
Method Summary
 int getCause()
          Returns the cause associated with this event.
 int getID()
          Returns the id of event.
 java.lang.Object getSource()
          Returns the event source of the event.
 

Field Detail

CAUSE_NORMAL

public static final int CAUSE_NORMAL
Cause code indicating a normal operation.

CAUSE_UNKNOWN

public static final int CAUSE_UNKNOWN
Cause code indicating the cause was unknown.

CAUSE_CALL_CANCELLED

public static final int CAUSE_CALL_CANCELLED
Cause code indicating the user has terminated call without going on-hook.

CAUSE_DEST_NOT_OBTAINABLE

public static final int CAUSE_DEST_NOT_OBTAINABLE
Cause code indicating the destination is not available.

CAUSE_INCOMPATIBLE_DESTINATION

public static final int CAUSE_INCOMPATIBLE_DESTINATION
Cause code indicating that a call has encountered an incompatible destination.

CAUSE_LOCKOUT

public static final int CAUSE_LOCKOUT
Cause code indicating that a call has encountered an inter-digit timeout while dialing.

CAUSE_NEW_CALL

public static final int CAUSE_NEW_CALL
Cause code indicating a new call.

CAUSE_RESOURCES_NOT_AVAILABLE

public static final int CAUSE_RESOURCES_NOT_AVAILABLE
Cause code indicating that resources were not available.

CAUSE_NETWORK_CONGESTION

public static final int CAUSE_NETWORK_CONGESTION
Cause code indicating that a call has encountered network congestion.

CAUSE_NETWORK_NOT_OBTAINABLE

public static final int CAUSE_NETWORK_NOT_OBTAINABLE
Cause code indicating that a call could not reach a destination network.

CAUSE_SNAPSHOT

public static final int CAUSE_SNAPSHOT
Cause code indicating that the event is part of a snapshot of the current state of the call.

CAUSE_REDIRECTED

public static final int CAUSE_REDIRECTED
Cause code indicating the cause was because of call being redirected.
Method Detail

getCause

public int getCause()
Returns the cause associated with this event. Every event has a cause. The various cause values are defined as public static final variables in this interface.
Returns:
the cause of the event.

getID

public int getID()
Returns the id of event. Every event has an id.
Returns:
the id of the event.

getSource

public java.lang.Object getSource()
Returns the event source of the event.
Returns:
The object sending the event.


3 Oct 2000
If you have any comments or queries, please mail them to jcc@research.telcordia.com


Copyright-2000 Sun Microsystems