JSR-043: JTAPI-1.4

javax.telephony
Interface ProviderListener

All Superinterfaces:
java.util.EventListener
All Known Subinterfaces:
MobileProviderListener, PrivateDataProviderListener

public interface ProviderListener
extends java.util.EventListener

The ProviderListener interface reports all changes which happen to the Provider object.

These state changes are reported as events to the ProviderListener method corresponding to the type of event.

Applications must instantiate an object which implements this interface and then use the Provider.addProviderListener()) method to register the object to receive all future events associated with the Provider object.

The ProviderListener methods each receive one event at a time, unlike the ProviderObserver.

Provider State Changes

In the core package, an event is delivered whenever the Provider changes state. The event interfaces which correspond to these state changes for the core package are: providerInService, providerOutOfService, and providerShutdown.

Provider Observation Ending

At various times, the underlying implementation may not be able to observe the Provider. In these instances, the ProviderListener is sent an JProvObservationEndedEv event, via the ProviderListener.providerListenerEndedEvent() method. This indicates that the application will not receive further events associated with the Provider object. This observer will no longer be reported via the Provider.getProviderListeners method.

See Also:
Provider, ProviderEvent

Method Summary
 void providerEventTransmissionEnded(ProviderEvent event)
          The providerEventTransmissionEnded method is called to indicate that the application will no longer receive Provider events on the instance of the ProviderListener.
 void providerInService(ProviderEvent event)
          The providerInService method is called to indicate that the state of the Provider object has changed to Provider.IN_SERVICE.
 void providerOutOfService(ProviderEvent event)
          The providerOutOfService method is called to indicate that the state of the Provider object has changed to Provider.OUT_OF_SERVICE.
 void providerShutdown(ProviderEvent event)
          The providerShutdown method is called to indicate that the state of the Provider object has changed to Provider.SHUTDOWN.
 

Method Detail

providerInService

public void providerInService(ProviderEvent event)
The providerInService method is called to indicate that the state of the Provider object has changed to Provider.IN_SERVICE.

Parameters:
a - ProviderEvent with event ID ProviderEvent.PROVIDER_IN_SERVICE.

providerEventTransmissionEnded

public void providerEventTransmissionEnded(ProviderEvent event)
The providerEventTransmissionEnded method is called to indicate that the application will no longer receive Provider events on the instance of the ProviderListener.

Parameters:
a - ProviderEvent with event ID ProviderEvent.PROVIDER_EVENT_TRANSMISSION_ENDED.

providerOutOfService

public void providerOutOfService(ProviderEvent event)
The providerOutOfService method is called to indicate that the state of the Provider object has changed to Provider.OUT_OF_SERVICE.

Parameters:
a - ProviderEvent with event ID ProviderEvent.PROVIDER_OUT_OF_SERVICE.

providerShutdown

public void providerShutdown(ProviderEvent event)
The providerShutdown method is called to indicate that the state of the Provider object has changed to Provider.SHUTDOWN.

Parameters:
a - ProviderEvent with event ID ProviderEvent.PROVIDER_SHUTDOWN.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org