javax.telephony.mobile
Interface MobileProviderEvent

All Superinterfaces:

Event, ProviderEvent

public interface MobileProviderEvent

extends ProviderEvent

The MobileProviderEvent interface is the interface for all mobileprovider events. Each event is specified by unique identification number, specified in the MobileProvider interface.

State and State Cause Mapping

In each state, the state cause must be set as described below:

MobileProvider State	MobileProviderEvent Cause
IN_SERVICE	CAUSE_NORMAL
RESTRICTED_SERVICE	CAUSE_FORBIDDEN, CAUSE_FORBIDDEN_ZONE, CAUSE_NETWORK_NOT_SELECTED, CAUSE_SUBSCRIPTION_ERROR or CAUSE_SEARCHING
SHUTDOWN	CAUSE_NORMAL
OUT_OF_SERVICE	CAUSE_RADIO_OFF, CAUSE_NO_NETWORK or CAUSE_UNKNOWN

See Also:

MobileProvider, MobileProviderEvent, MobileProviderListener

Field Summary

static int	CAUSE_FORBIDDEN The MobileProvider.CAUSE_FORBIDDEN cause indicates the provider is in the restricted state because the current network is forbidden i.e., emergency calls only.
static int	CAUSE_FORBIDDEN_ZONE The MobileProvider.CAUSE_FORBIDDEN_ZONE cause indicates the provider is in the restricted state because the mobile phone is currently in a forbidden regional zone i.e., only emergency calls are allowed.
static int	CAUSE_ILLEGAL_MOBILE The MobileProvider.CAUSE_ILLEGAL_MOBILE indicates there maybe a problem with mobile equipment ID information.
static int	CAUSE_NETWORK_NOT_SELECTED The MobileProvider.CAUSE_NETWORK_NOT_SELECTED value indicates that currently no network is selected but networks are available in the area.
static int	CAUSE_NO_NETWORK The MobileProvider.CAUSE_NO_NETWORK value indicates there is no cellular networks detected in the area.
static int	CAUSE_NORMAL The MobileProvider.CAUSE_NORMAL cause indicates there is no cause.
static int	CAUSE_RADIO_OFF The MobileProvider.CAUSE_RADIO_OFF cause indicates that the radio is turned off.
static int	CAUSE_SEARCHING The MobileProvider.CAUSE_SEARHING indicates the implementation is searching for cellular networks.
static int	CAUSE_SUSBCRIPTION_ERROR The MobileProvider.CAUSE_SUSBSCRIPTION_ERROR cause indicates the provider is in the restricted or in out_of_service state because of a subscription related error.
static int	CAUSE_UNKNOWN The MobileProvider.CAUSE_UNKNOWN value indicates the reason for state is not available or is none of the above causes.
static int	MOBILEPROVIDER_NETWORK_CHANGE The event id for MobileProvider network change.
static int	MOBILEPROVIDER_NO_NETWORK The event id for MobileProvider no network situation.
static int	PROVIDER_RESTRICTED_SERVICE The event id for MobileProvider state change for restricted network service.

Fields inherited from interface javax.telephony.ProviderEvent

PROVIDER_EVENT_TRANSMISSION_ENDED, PROVIDER_IN_SERVICE, PROVIDER_OUT_OF_SERVICE, 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_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT

Method Summary

MobileProvider	getMobileProvider() Returns the MobileProvider associated with this event.
int	getMobileStateCause() Returns the cause for a service state.

Methods inherited from interface javax.telephony.ProviderEvent

getProvider

Methods inherited from interface javax.telephony.Event

getCause, getID, getMetaEvent, getSource

Field Detail

CAUSE_NORMAL

public static final int CAUSE_NORMAL

The MobileProvider.CAUSE_NORMAL cause indicates there is no cause.

CAUSE_FORBIDDEN

public static final int CAUSE_FORBIDDEN

The MobileProvider.CAUSE_FORBIDDEN cause indicates the provider is in the restricted state because the current network is forbidden i.e., emergency calls only.

CAUSE_FORBIDDEN_ZONE

public static final int CAUSE_FORBIDDEN_ZONE

The MobileProvider.CAUSE_FORBIDDEN_ZONE cause indicates the provider is in the restricted state because the mobile phone is currently in a forbidden regional zone i.e., only emergency calls are allowed.

CAUSE_SUSBCRIPTION_ERROR

public static final int CAUSE_SUSBCRIPTION_ERROR

The MobileProvider.CAUSE_SUSBSCRIPTION_ERROR cause indicates the provider is in the restricted or in out_of_service state because of a subscription related error. The SIM is either missing or there is some other problem such as invalid entry code.

CAUSE_RADIO_OFF

public static final int CAUSE_RADIO_OFF

The MobileProvider.CAUSE_RADIO_OFF cause indicates that the radio is turned off. In other words, the MobileRadio is off.

CAUSE_NO_NETWORK

public static final int CAUSE_NO_NETWORK

The MobileProvider.CAUSE_NO_NETWORK value indicates there is no cellular networks detected in the area.

CAUSE_NETWORK_NOT_SELECTED

public static final int CAUSE_NETWORK_NOT_SELECTED

The MobileProvider.CAUSE_NETWORK_NOT_SELECTED value indicates that currently no network is selected but networks are available in the area.

CAUSE_SEARCHING

public static final int CAUSE_SEARCHING

The MobileProvider.CAUSE_SEARHING indicates the implementation is searching for cellular networks.

CAUSE_ILLEGAL_MOBILE

public static final int CAUSE_ILLEGAL_MOBILE

The MobileProvider.CAUSE_ILLEGAL_MOBILE indicates there maybe a problem with mobile equipment ID information. This cause is because sometimes the subscription ID is not available and the mobile equipment ID is used to authenticate the mobile. It is through this that invalid or stolen equipment can be identified and the network will refuse normal service, but will provide restricted (emergency) service. Some systems keep a list of stolen mobiles - called the black list. Gray list is mobiles that have some software or radio problem and need to be recalled.

CAUSE_UNKNOWN

public static final int CAUSE_UNKNOWN

The MobileProvider.CAUSE_UNKNOWN value indicates the reason for state is not available or is none of the above causes.

PROVIDER_RESTRICTED_SERVICE

public static final int PROVIDER_RESTRICTED_SERVICE

The event id for MobileProvider state change for restricted network service.

MOBILEPROVIDER_NETWORK_CHANGE

public static final int MOBILEPROVIDER_NETWORK_CHANGE

The event id for MobileProvider network change.

MOBILEPROVIDER_NO_NETWORK

public static final int MOBILEPROVIDER_NO_NETWORK

The event id for MobileProvider no network situation.

Method Detail

getMobileProvider

public MobileProvider getMobileProvider()

Returns the MobileProvider associated with this event.

Returns:

The MobileProvider associated with this event.

getMobileStateCause

public int getMobileStateCause()

Returns the cause for a service state.

Returns:

a cause value.