com.nokia.mid.iapinfo
Class IAPInfo

java.lang.Object
  com.nokia.mid.iapinfo.IAPInfo

public abstract class IAPInfo
extends java.lang.Object

IAPInfo includes methods for retrieving information of Access Points and Destination Networks. There is only one instance of IAPInfo. You obtain it by calling getIAPInfo() method: Obtain IAPInfo object by factory:

IAPInfo iapinfo = IAPInfo.getIAPInfo();

With this object you can get following information:

• array of DestinationNetwork by calling getDestinationNetworks()
• array of AccessPoint by calling getAccessPoints()
• array of last used access points getLastUsedAccessPoints()
• array of prefered access points getConnectionPreferences()

Method Summary

abstract AccessPoint	getAccessPoint(int aID) Gets an access point from the system by its ID.
abstract AccessPoint	getAccessPoint(java.lang.String aName) Gets an access point from the system with given name.
abstract AccessPoint[]	getAccessPoints() Gets the array of system defined Access Points.
abstract AccessPoint[]	getConnectionPreferences() Gets a connection preferences.
abstract DestinationNetwork	getDestinationNetwork(int aID) Gets a destination network by its ID.
abstract DestinationNetwork	getDestinationNetwork(java.lang.String aName) Gets a destination network by its name.
abstract DestinationNetwork[]	getDestinationNetworks() Gets the destination networks available in the system.
static IAPInfo	getIAPInfo() Factory method for obtaining IAPInfo object.
abstract AccessPoint	getLastUsedAccessPoint() Gets the last used access point by the MIDlet suite.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getIAPInfo

public static IAPInfo getIAPInfo()
                          throws IAPInfoException

Factory method for obtaining IAPInfo object.

Returns:

an IAPInfo object

Throws:

IAPInfoException - if IAPInfo can't be created

getAccessPoints

public abstract AccessPoint[] getAccessPoints()
                                       throws IAPInfoException

Gets the array of system defined Access Points. If no Access Points array's length is 0.

Returns:

an Access point array.

Throws:

IAPInfoException - on error obtaining list of Access Points.

getAccessPoint

public abstract AccessPoint getAccessPoint(int aID)
                                    throws IAPInfoException

Gets an access point from the system by its ID. If no Access point is found, the method returns null.

Parameters:

aID - the access point id

Returns:

an Access Point or null if not found

Throws:

IAPInfoException - on error obtaining Access Points.

getAccessPoint

public abstract AccessPoint getAccessPoint(java.lang.String aName)
                                    throws IAPInfoException

Gets an access point from the system with given name. If no access point found, then the method returns null.

Parameters:

aName - name of the access point

Returns:

an Access Point object or null if not found

Throws:

IAPInfoException - on error obtaining Access Points.

getLastUsedAccessPoint

public abstract AccessPoint getLastUsedAccessPoint()
                                            throws IAPInfoException

Gets the last used access point by the MIDlet suite. If no Access Point is found then the method returns null.

Returns:

an Access point object or null if not found

Throws:

IAPInfoException - on error obtaining Access Points.

getDestinationNetworks

public abstract DestinationNetwork[] getDestinationNetworks()
                                                     throws IAPInfoException

Gets the destination networks available in the system. Returns with an array of DestinationNetwork objects. If no destination network is found, then the method returns array sized 0.

Returns:

a DestinationNetwork object array

Throws:

IAPInfoException - on error obtaining Access Points.

getDestinationNetwork

public abstract DestinationNetwork getDestinationNetwork(int aID)
                                                  throws IAPInfoException

Gets a destination network by its ID.

Parameters:

aID - the ID of the destination network

Returns:

a DestinationNetwork object

Throws:

IAPInfoException - on error obtainging Destination Network

getDestinationNetwork

public abstract DestinationNetwork getDestinationNetwork(java.lang.String aName)
                                                  throws IAPInfoException

Gets a destination network by its name.

Parameters:

aName - the name of the destination network

Returns:

a DestinationNetwork object

Throws:

IAPInfoException - on error obtainging Destination Network

getConnectionPreferences

public abstract AccessPoint[] getConnectionPreferences()
                                                throws IAPInfoException

Gets a connection preferences. Connection preferences is a set of applications' prefered Access Points ordered according to their priority.

Returns:

an AccessPoint object array

Throws:

IAPInfoException - on error obtainging list of Access Points