JCAT
v0.3.1

javax.csapi.cc.jcc
Interface JccEvent

All Known Subinterfaces:
CallLoadControlEvent, JcatAddressEvent, JcatCallEvent, JcatConnectionEvent, JcatTerminalConnectionEvent, JcatTerminalEvent, JccCallEvent, JccConnectionEvent, JccProviderEvent

public interface JccEvent

The Event interface is the parent of all JCC 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 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.

Since:
1.0b

Field Summary
static int CAUSE_BUSY
          The user is busy.
static int CAUSE_CALL_CANCELLED
          Cause code indicating the user has terminated call.
static int CAUSE_CALL_RESTRICTED
          A disconnect was received.
static int CAUSE_DEST_NOT_OBTAINABLE
          Cause code indicating the destination is not available.
static int CAUSE_GENERAL_FAILURE
          A general network failure occurred.
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_MORE_DIGITS_NEEDED
          Cause code indicating that the network needs more addressing information to complete the call.
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_NO_ANSWER
          No answer was received.
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_TIMER_EXPIRY
          The connection was released because an activity timer expired.
static int CAUSE_UNKNOWN
          Cause code indicating the cause was unknown.
static int CAUSE_USER_NOT_AVAILABLE
          The user isn't available in the network.
 
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.

See Also:
Constant Field Values

CAUSE_UNKNOWN

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

See Also:
Constant Field Values

CAUSE_CALL_CANCELLED

public static final int CAUSE_CALL_CANCELLED
Cause code indicating the user has terminated call. This can be either because of the user going on-hook or because the call has been terminated by the service logic.

See Also:
Constant Field Values

CAUSE_DEST_NOT_OBTAINABLE

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

See Also:
Constant Field Values

CAUSE_INCOMPATIBLE_DESTINATION

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

See Also:
Constant Field Values

CAUSE_LOCKOUT

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

See Also:
Constant Field Values

CAUSE_NEW_CALL

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

See Also:
Constant Field Values

CAUSE_RESOURCES_NOT_AVAILABLE

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

See Also:
Constant Field Values

CAUSE_NETWORK_CONGESTION

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

See Also:
Constant Field Values

CAUSE_NETWORK_NOT_OBTAINABLE

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

See Also:
Constant Field Values

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.

See Also:
Constant Field Values

CAUSE_REDIRECTED

public static final int CAUSE_REDIRECTED
Cause code indicating the cause was because of call being redirected. If this cause code occurs, the event id. is always JccConnectionEvent.CONNECTION_DISCONNECTED and the connection returned by JccConnectionEvent.getConnection() is a terminating connection.

See Also:
Constant Field Values

CAUSE_MORE_DIGITS_NEEDED

public static final int CAUSE_MORE_DIGITS_NEEDED
Cause code indicating that the network needs more addressing information to complete the call.

See Also:
Constant Field Values

CAUSE_BUSY

public static final int CAUSE_BUSY
The user is busy. This value may be returned by getCause().

See Also:
Constant Field Values

CAUSE_NO_ANSWER

public static final int CAUSE_NO_ANSWER
No answer was received. This value may be returned by getCause().

See Also:
Constant Field Values

CAUSE_CALL_RESTRICTED

public static final int CAUSE_CALL_RESTRICTED
A disconnect was received. This value may be returned by getCause().

See Also:
Constant Field Values

CAUSE_GENERAL_FAILURE

public static final int CAUSE_GENERAL_FAILURE
A general network failure occurred. This value may be returned by getCause().

See Also:
Constant Field Values

CAUSE_TIMER_EXPIRY

public static final int CAUSE_TIMER_EXPIRY
The connection was released because an activity timer expired. This value may be returned by getCause().

See Also:
Constant Field Values

CAUSE_USER_NOT_AVAILABLE

public static final int CAUSE_USER_NOT_AVAILABLE
The user isn't available in the network. This means that the number isn't allocated or that the user isn't registered. This value may be returned by getCause().

See Also:
Constant Field Values
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.

JCAT
v0.3.1

August, 2003
If you have any comments or queries, please mail them to JSR-122-EG@JCP.ORG

Copyright - 2001, 2003 Sun Microsystems