JSR-043: JTAPI-1.4

javax.telephony.mobile
Interface NetworkSelection

All Superinterfaces:
MobileProvider, Provider

public interface NetworkSelection
extends MobileProvider

The NetworkSelection interface provides the specific list based services.

Users may choose between manual and automatic network selection and may interact with lists of preferred and forbidden network lists. (See GSM 03.22 Public Land Mobile Network)

See Also:
MobileProvider

Fields inherited from interface javax.telephony.mobile.MobileProvider
RESTRICTED_SERVICE
 
Fields inherited from interface javax.telephony.Provider
IN_SERVICE, OUT_OF_SERVICE, SHUTDOWN
 
Method Summary
 java.lang.String getCurrentSelectionMode()
          Returns the current network selection mode.
 MobileNetwork[] getForbiddenNetworks()
          Returns the network list specified.
 MobileNetwork[] getPreferredNetworks()
          Returns the network list specified.
 java.lang.String[] getSelectionModes()
          Returns the (automatic) network selection algorithm modes available.
 void setSelectionMode(java.lang.String mode)
          Sets the network selection mode.
 
Methods inherited from interface javax.telephony.mobile.MobileProvider
cancelAvailableNetworkRequest, getAvailableNetworks, getCurrentNetwork, getHomeNetwork, getMobileState, getNetworkTime, getNetworkTimeZone, getType, isRoaming, setNetwork
 
Methods inherited from interface javax.telephony.Provider
addObserver, addProviderListener, createCall, getAddress, getAddressCapabilities, getAddressCapabilities, getAddresses, getCallCapabilities, getCallCapabilities, getCalls, getCapabilities, getConnectionCapabilities, getConnectionCapabilities, getName, getObservers, getProviderCapabilities, getProviderCapabilities, getProviderListeners, getState, getTerminal, getTerminalCapabilities, getTerminalCapabilities, getTerminalConnectionCapabilities, getTerminalConnectionCapabilities, getTerminals, removeObserver, removeProviderListener, shutdown
 

Method Detail

getCurrentSelectionMode

public java.lang.String getCurrentSelectionMode()
                                         throws MethodNotSupportedException
Returns the current network selection mode. The mode must be null if the current mode is manual i.e., the network was selected by using the setNetwork-method.

Returns:
The current selection mode String object.
Throws:
MethodNotSupportedException - Indicates network selection is not supported.

getSelectionModes

public java.lang.String[] getSelectionModes()
                                     throws MethodNotSupportedException
Returns the (automatic) network selection algorithm modes available. If no other selection modes than the manual selection is available, than this must return null. The modes are cellular network system and implementation specific. For example, in GSM-system this might return only one string: "AUTOMATIC" and in CDMA-systems, the modes could be "PREFERRED", "ALTERNATE" and "HOME" or similar. In other words, this is totally up to the implementation.

Returns:
The selection modes available names as text strings.
Throws:
MethodNotSupportedException - Indicates network selection is not supported.

setSelectionMode

public void setSelectionMode(java.lang.String mode)
                      throws InvalidArgumentException,
                             MethodNotSupportedException,
                             InvalidStateException
Sets the network selection mode. These modes are cellular system and implementation specific and are usually automatic selection algorithms. If the mode is null, then the action must be same as for setNetwork i.e., manual.
Parameters:
mode - Mode to be selected (or null for manual mode)
Throws:
MethodNotSupportedException - Indicates the setting of the selection mode capability is not supported.
InvalidArgumentException - Indicates that the input parameter is invalid.
InvalidStateException - Indicates the implementation is in a state in which setting the network selection mode is not possible (call ongoing, for example).

getPreferredNetworks

public MobileNetwork[] getPreferredNetworks()
                                     throws MethodNotSupportedException,
                                            ResourceUnavailableException
Returns the network list specified. The information in network lists might change at any time.

Preferred Networks are network service carriers the user has found to offer service, and is preferred over other networks.

Returns:
A list of networks.
Throws:
MethodNotSupportedException - Indicates the capability to get network lists is not supported.
ResourceUnavailableException - Indicates that a resource inside the system in not available to complete an operation.

getForbiddenNetworks

public MobileNetwork[] getForbiddenNetworks()
                                     throws MethodNotSupportedException,
                                            ResourceUnavailableException
Returns the network list specified. The information in network lists might change at any time.

Forbidden Networks are network service carriers to which the user's home network carrier has no agreement of cross service or to which the user has reason (cost) not to use this network.

Returns:
A list of networks.
Throws:
MethodNotSupportedException - Indicates the capability to get network lists is not supported.
ResourceUnavailableException - Indicates that a resource inside the system in not available to complete an operation.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org