com.esf.device.usb.manager.modem.service
Interface IUsbModemManagerService


public interface IUsbModemManagerService

Provides tools for managing USB modem devices.

Author:
wes.johnson

Field Summary
static java.lang.String MODEM_ATTACHED_TOPIC
           
static java.lang.String MODEM_DETACHED_TOPIC
           
static java.lang.String SERVICE_NAME
          Reports the class name representing this interface.
 
Method Summary
 boolean areDevicesPresent()
          This method returns whether or not there are any devices currently attached.
 java.lang.String[] getDeviceUsbPorts()
          Returns an array of Strings that represent the USB port names of the connected modems
 java.lang.String[] getSerialPorts(java.lang.String usbPortNumber)
          Returns the serial ports that have been assigned to the USB modem attached to a specific USB port
 SupportedUsbModems getSupportedModems()
          returns the list of supported USB modems
 void registerListener(UsbModemListener listener)
          registers a listener with the IUsbModemManagerServers
 void unregisterListener(UsbModemListener listener)
          unregisters a listener with the IUsbModemManagerServers
 

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME
Reports the class name representing this interface.


MODEM_ATTACHED_TOPIC

static final java.lang.String MODEM_ATTACHED_TOPIC
See Also:
Constant Field Values

MODEM_DETACHED_TOPIC

static final java.lang.String MODEM_DETACHED_TOPIC
See Also:
Constant Field Values
Method Detail

areDevicesPresent

boolean areDevicesPresent()
This method returns whether or not there are any devices currently attached.

Returns:
True if there are any devices attached, false otherwise.

getDeviceUsbPorts

java.lang.String[] getDeviceUsbPorts()
Returns an array of Strings that represent the USB port names of the connected modems

Returns:
An array of Strings that represent the USB port names of the connected modems

getSerialPorts

java.lang.String[] getSerialPorts(java.lang.String usbPortNumber)
Returns the serial ports that have been assigned to the USB modem attached to a specific USB port

Parameters:
usbPortNumber - A String representing the USB port that the device is plugged into.
Returns:
An array or Strings representing the ports assigned to the device. Returns null if no modem is connected to the specified USB port

registerListener

void registerListener(UsbModemListener listener)
registers a listener with the IUsbModemManagerServers

Parameters:
listener - the UsbModemListener to register

unregisterListener

void unregisterListener(UsbModemListener listener)
unregisters a listener with the IUsbModemManagerServers

Parameters:
listener - the UsbModemListener to unregister

getSupportedModems

SupportedUsbModems getSupportedModems()
returns the list of supported USB modems

Returns:
the USB modems supported by this bundle