JSR-043: JTAPI-1.4

javax.telephony
Interface ProviderEvent

All Superinterfaces:
Event
All Known Subinterfaces:
MobileProviderEvent

public interface ProviderEvent
extends Event

The ProviderEvent interface is the base interface for all Provider related events. All events which pertain to the Provider object must extend this interface. Events which extend this interface are reported via the ProviderListener interface.

The core package defines events which are reported when the Provider changes state. These events are: PROVIDER_IN_SERVICE, PROVIDER_OUT_OF_SERVICE, and PROVIDER_SHUTDOWN. Also, the core package defines the PROVIDER_EVENT_TRANSMISSION_ENDED event which is sent when the Provider becomes unobservable.

The ProviderEvent.getProvider method on this interface returns the Provider associated with the Provider event.

See Also:
Event, ProviderListener, Provider

Field Summary
static int PROVIDER_EVENT_TRANSMISSION_ENDED
          The PROVIDER_EVENT_TRANSMISSION_ENDED event indicates that the application will no longer receive Provider events on the instance of the ProviderListener.
static int PROVIDER_IN_SERVICE
          The PROVIDER_IN_SERVICE interface indicates that the state of the Provider object has changed to Provider.IN_SERVICE.
static int PROVIDER_OUT_OF_SERVICE
          The PROVIDER_OUT_OF_SERVICE interface indicates that the state of the Provider object has changed to Provider.OUT_OF_SERVICE.
static int PROVIDER_SHUTDOWN
          The PROVIDER_SHUTDOWN interface indicates that the state of the Provider object has changed to Provider.SHUTDOWN.
 
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
 Provider getProvider()
          Returns the Provider associated with this Provider event.
 
Methods inherited from interface javax.telephony.Event
getCause, getID, getMetaEvent, getSource
 

Field Detail

PROVIDER_IN_SERVICE

public static final int PROVIDER_IN_SERVICE
The PROVIDER_IN_SERVICE interface indicates that the state of the Provider object has changed to Provider.IN_SERVICE.

This constant indicates a specific event passed via a ProviderEvent event, and is reported on the ProviderListener interface.


PROVIDER_EVENT_TRANSMISSION_ENDED

public static final int PROVIDER_EVENT_TRANSMISSION_ENDED
The PROVIDER_EVENT_TRANSMISSION_ENDED event indicates that the application will no longer receive Provider events on the instance of the ProviderListener.

This constant indicates a specific event passed via a ProviderEvent event, and is reported on the ProviderListener interface.


PROVIDER_OUT_OF_SERVICE

public static final int PROVIDER_OUT_OF_SERVICE
The PROVIDER_OUT_OF_SERVICE interface indicates that the state of the Provider object has changed to Provider.OUT_OF_SERVICE.

This constant indicates a specific event passed via a ProviderEvent event, and is reported on the ProviderListener interface.


PROVIDER_SHUTDOWN

public static final int PROVIDER_SHUTDOWN
The PROVIDER_SHUTDOWN interface indicates that the state of the Provider object has changed to Provider.SHUTDOWN.

This constant indicates a specific event passed via a ProviderEvent event, and is reported on the ProviderListener interface.

Method Detail

getProvider

public Provider getProvider()
Returns the Provider associated with this Provider event.

Returns:
The Provider associated with this event.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org