JSR-043: JTAPI-1.4

javax.telephony.mobile
Interface MobileTerminal

All Superinterfaces:
Terminal

public interface MobileTerminal
extends Terminal

A MobileTerminal represents a physical hardware endpoint connected to a wireless telephony domain. An example of a MobileTerminal is a mobile phone connected to a laptop via serial port. For example, computer workstations and handheld (PDA) devices are modeled as MobileTerminals if they act as physical endpoints in a cellular telephony network. This interface extends the core Terminal with capabilities to get the manufacturer name, the terminal identification and the type approval number.

DTMF tone generation is handled in this interface to allow for communication with legacy server applications which expect tone inputs to be sent from a dumb telephony terminal.

Note: in mobile networks the tones are not typically generated from the terminal node, but are handled by the network itself. An implementation of this interface is responsible for propagating the tones appropriately.

See Also:
Terminal, MobileProvider

Method Summary
 boolean generateDTMF(java.lang.String digits)
          Generates one or more DTMF tones.
 java.lang.String getManufacturerName()
          Returns the Mobile's Manufacturer Name.
 java.lang.String getSoftwareVersion()
          Returns the Software Version String.
 java.lang.String getTerminalId()
          Returns the Terminal Identification String.
 java.lang.String getTypeApproval()
          Returns the type approval String.
 boolean startDTMF(char digit)
          Generates one continuous DTMF tone.
 void stopDTMF()
          Stop the continuous DTMF tone being generated on the telephone line.
 
Methods inherited from interface javax.telephony.Terminal
addCallListener, addCallObserver, addObserver, addTerminalListener, getAddresses, getCallListeners, getCallObservers, getCapabilities, getName, getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, getTerminalListeners, removeCallListener, removeCallObserver, removeObserver, removeTerminalListener
 

Method Detail

getTerminalId

public java.lang.String getTerminalId()
Returns the Terminal Identification String. This methods returns an equipment ID string such as IMEI or ESN. (International Mobile Equipment Identification) or (Electronic Serial Number)

Returns:
an equipment ID String, NULL if no such ID is implemented.

getManufacturerName

public java.lang.String getManufacturerName()
Returns the Mobile's Manufacturer Name.

Returns:
an manufacturer name String, NULL if not implemented.

getSoftwareVersion

public java.lang.String getSoftwareVersion()
Returns the Software Version String. This methods returns a software version string.

Returns:
a software version String, NULL if not implemented.

getTypeApproval

public java.lang.String getTypeApproval()
Returns the type approval String. This methods returns a type approval string.

Returns:
a type approval String, NULL if not implemented.

startDTMF

public boolean startDTMF(char digit)
                  throws MethodNotSupportedException
Generates one continuous DTMF tone. The character parameter must consist of one of the following characters: the numbers zero through nine (0 - 9), the letters A through D, asterisk (*), or pound(#).
Parameters:
digit - The DTMF-tone digit to generate on the telephone line.
Returns:
true if a tone was successfully delivered.
Throws:
MethodNotSupportedException - The implementation does not support generating DTMF tones.

stopDTMF

public void stopDTMF()
Stop the continuous DTMF tone being generated on the telephone line.

generateDTMF

public boolean generateDTMF(java.lang.String digits)
                     throws MethodNotSupportedException
Generates one or more DTMF tones. The string parameter must consists of one or more of the following characters: the numbers zero through nine (0 - 9), the letters A through D, asterisk (*), or pound(#). Any other characters in the string parameter are ignored.
Parameters:
digits - The string of DTMF-tone digits to generate on the telephone line.
Returns:
true if a tone was successfully delivered.
Throws:
MethodNotSupportedException - The implementation does not support generating DTMF tones.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org