com.nokia.m2m.orb.idl.terminal
Interface ETOperations

All Superinterfaces:
DeviceOperations

public interface ETOperations
extends DeviceOperations

Module ORB servant implementing the ETOperations interface.
Reference to this servant can be obtained by using the following name:

Some of the methods are only supported by the real Nokia 12 GSM module, not by the Nokia 12 IMP 1.0 Concept Simulator.
Methods not supported by the Nokia 12 IMP 1.0 Concept Simulator are defined in this interfaces for the compatibility but they will not implement any kind of functionality. Following methods are supported both by the Nokia 12 GSM module and the Nokia 12 IMP 1.0 Concept Simulator:


Method Summary
 void addPhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt, String text, String phoneNumber, org.omg.CORBA.IntHolder index)
          Adds a new entry to the phonebook.
 void answerCall(int id)
          Method call is used for answering to mobile terminated voice calls.
 void changeSecurityCode(com.nokia.m2m.orb.idl.terminal.ETPackage.SecurityCodeType sct, String oldCode, String newCode)
          Method call is used for changing security codes.
 void closeConnection(byte connectionId)
          Method call is used for closing a connection in use.
 byte createConnection(com.nokia.m2m.orb.idl.terminal.ETPackage.BearerInformation connectionData)
          Method call is used for creating new connections.
 void destroyConnection(byte connectionId)
          Method call is used for deleting connections from Nokia GSM Connectivity Terminal.
 void dropAllCalls()
          Method call is used for dropping all calls active for the terminal.
 void dropCall(int id)
          Method call is used for dropping either mobile originated (MO) or mobile terminated (MT) calls.
 void editPhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt, int index, String text, String phoneNumber)
          Allows you to edit a phonebook entry.
 void findPhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt, String text, com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookEntryIndexListHolder pbeil)
          Searches phonebook entries.
 void generateDTMFTones(String digits)
           
 void getCallForwarding(com.nokia.m2m.orb.idl.terminal.ETPackage.CallForwardReason cfr, org.omg.CORBA.StringHolder phoneNumber, org.omg.CORBA.BooleanHolder active, com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass cl, org.omg.CORBA.ShortHolder time)
          Method call is used for getting call forwarding service status from network.
 void getFacilityLock(com.nokia.m2m.orb.idl.terminal.ETPackage.FacilityType ft, com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass[] ccl, org.omg.CORBA.BooleanHolder active)
          Method call is used for retrieving activity status of a facility lock of choice.
 void getLed(short index, com.nokia.m2m.orb.idl.terminal.ETPackage.LedModeHolder mode)
          Method call is used for getting the mode of one of the leds of the terminal.
 void getPhonebookSize(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt, org.omg.CORBA.IntHolder numberOfEntries, org.omg.CORBA.IntHolder numberOfUsedEntries, org.omg.CORBA.IntHolder numberLength, org.omg.CORBA.IntHolder textLength)
          Retrieves phonebook capacity and usage information.
 void holdCall(int id)
          Method call is used for putting the call of choice to hold.
 String IMEI()
          The attribute returns terminal’s International Mobile Equipment Identity (IMEI).
 void initiateCall(String phoneNumber, org.omg.CORBA.IntHolder id)
          Method call is used for initiating mobile originated voice calls.
 void joinCall(int id)
          Method call is used for joining active and calls on hold together and thus making a conference call.
 short numberOfLeds()
          Returns the number of allowed leds.
 void powerDown()
           
 void readPhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt, int index, org.omg.CORBA.StringHolder text, org.omg.CORBA.StringHolder phoneNumber)
          Reads an entry from the phonebook.
 void readShortMessage(com.nokia.m2m.orb.idl.terminal.ETPackage.MessageStorage ms, int index, org.omg.CORBA.StringHolder message, org.omg.CORBA.StringHolder phoneNumber)
          Method call is used for reading short messages from the specified message storage.
 void removeCallForwarding(com.nokia.m2m.orb.idl.terminal.ETPackage.CallForwardReason cfr, com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass[] ccl)
          Method call is used for removing call-forwarding services provided by the GSM network.
 void removePhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt, int index)
          Removes an entry from the phonebook.
 void removeShortMessage(com.nokia.m2m.orb.idl.terminal.ETPackage.MessageStorage ms, int index)
          Method call is used for removing short messages from the specified message storage.
 void retrieveCall(int id)
          Method call is used for retrieving a call on hold and activating it.
 void sendShortMessage(String phoneNumber, String message, org.omg.CORBA.IntHolder reference)
          Method call is used for sending short messages with the terminal.
 boolean sendSSCode(String data)
          Method call is used for sending supplementary service codes.
 void setCallForwarding(com.nokia.m2m.orb.idl.terminal.ETPackage.CallForwardReason cfr, String phoneNumber, com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass[] ccl, short time)
          Method call is used for setting on call forwarding services.
 byte setConnection(byte connectionId)
          Method call is used for setting a connection created by createConnection to be used in the terminal.
 void setFacilityLock(com.nokia.m2m.orb.idl.terminal.ETPackage.FacilityType ft, com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass[] ccl, boolean locked, String password)
          Method call is used for manipulating facility locks.
 void setLed(short index, com.nokia.m2m.orb.idl.terminal.ETPackage.LedMode mode)
          Method call is used for setting the leds of the Nokia GSM Connectivity Terminal.
 void setSecurityCode(com.nokia.m2m.orb.idl.terminal.ETPackage.SecurityCodeType sct, String code)
          Method call is used for setting a security code queried by the Nokia GSM Connectivity Terminal.
 void splitCall(int id)
          Method call is used for splitting one member from a conference call to a private call.
 void swapCalls(int id)
          Method call is used for swapping between an active call and a call on hold.
 void transferCall(int id)
          Method call is used for transferring an active call to another party that is on hold.
 
Methods inherited from interface com.nokia.m2m.orb.idl.wirelessdevice.DeviceOperations
getCounter, getCounterList, getDeviceInfo, getObjectNames, getObjectRef, getObjectRefList, getParam, getParamList, removeAllObservers, removeEventObserver, removeParamObserver, reset, setEventObserver, setParam, setParamList, setParamObserver
 

Method Detail

IMEI

public String IMEI()
The attribute returns terminal’s International Mobile Equipment Identity (IMEI).

Returns:

powerDown

public void powerDown()

numberOfLeds

public short numberOfLeds()
Returns the number of allowed leds.

Returns:

setLed

public void setLed(short index,
                   com.nokia.m2m.orb.idl.terminal.ETPackage.LedMode mode)
            throws com.nokia.m2m.orb.idl.terminal.ETPackage.LedIndexOutOfRangeException
Method call is used for setting the leds of the Nokia GSM Connectivity Terminal. Please refer to product-specific documents for more detailed information on leds in use.

Parameters:
index - Index of the led.
mode - Mode for wanted led.
Throws:
LedIndexOutOfRangeException

getLed

public void getLed(short index,
                   com.nokia.m2m.orb.idl.terminal.ETPackage.LedModeHolder mode)
            throws com.nokia.m2m.orb.idl.terminal.ETPackage.LedIndexOutOfRangeException
Method call is used for getting the mode of one of the leds of the terminal.

Parameters:
index -
mode -
Throws:
LedIndexOutOfRangeException

sendShortMessage

public void sendShortMessage(String phoneNumber,
                             String message,
                             org.omg.CORBA.IntHolder reference)
                      throws com.nokia.m2m.orb.idl.terminal.ETPackage.ServiceCentreAddressUndefinedException,
                             com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException
Method call is used for sending short messages with the terminal. Short messages can only be sent when terminal is in service state.

Parameters:
phoneNumber -
message -
reference -
Throws:
GeneralFailureException
com.nokia.m2m.orb.idl.terminal.ETPackage.ServiceCentreAddressUndefinedException

readShortMessage

public void readShortMessage(com.nokia.m2m.orb.idl.terminal.ETPackage.MessageStorage ms,
                             int index,
                             org.omg.CORBA.StringHolder message,
                             org.omg.CORBA.StringHolder phoneNumber)
                      throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                             com.nokia.m2m.orb.idl.terminal.ETPackage.ShortMessageIndexOutOfRangeException,
                             com.nokia.m2m.orb.idl.terminal.ETPackage.ShortMessageLocationEmptyException
Method call is used for reading short messages from the specified message storage.

Parameters:
ms -
index -
message -
phoneNumber -
Throws:
ShortMessageLocationEmptyException
GeneralFailureException
com.nokia.m2m.orb.idl.terminal.ETPackage.ShortMessageIndexOutOfRangeException

removeShortMessage

public void removeShortMessage(com.nokia.m2m.orb.idl.terminal.ETPackage.MessageStorage ms,
                               int index)
                        throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                               com.nokia.m2m.orb.idl.terminal.ETPackage.ShortMessageIndexOutOfRangeException,
                               com.nokia.m2m.orb.idl.terminal.ETPackage.ShortMessageLocationEmptyException
Method call is used for removing short messages from the specified message storage.

Parameters:
ms -
index -
Throws:
ShortMessageIndexOutOfRangeException
ShortMessageLocationEmptyException
GeneralFailureException

changeSecurityCode

public void changeSecurityCode(com.nokia.m2m.orb.idl.terminal.ETPackage.SecurityCodeType sct,
                               String oldCode,
                               String newCode)
                        throws com.nokia.m2m.orb.idl.terminal.ETPackage.SecurityCodeChangeDeniedException,
                               com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                               com.nokia.m2m.orb.idl.terminal.ETPackage.SecurityCodeRejectedException
Method call is used for changing security codes.

Parameters:
oldCode -
newCode -
Throws:
SecurityCodeRejectedException
SecurityCodeChangeDeniedException
GeneralFailureException

setSecurityCode

public void setSecurityCode(com.nokia.m2m.orb.idl.terminal.ETPackage.SecurityCodeType sct,
                            String code)
                     throws com.nokia.m2m.orb.idl.terminal.ETPackage.SecurityCodeNotRequiredException
Method call is used for setting a security code queried by the Nokia GSM Connectivity Terminal. The terminal queries security codes by sending SECURITYCODE-REQUIRED event to the application module. When the code is accepted SECURITYCODE-ACCEPTED event is sent to the application module. This method call is only allowed for devices attached physically to the terminal. Note: When entering wrong PIN code three times in a row, setSecurityCode method call raises SecurityCodeNotRequired exception. This is correct behaviour and PUK-code must be used after the exception.

Parameters:
sct -
code -
Throws:
SecurityCodeNotRequiredException

initiateCall

public void initiateCall(String phoneNumber,
                         org.omg.CORBA.IntHolder id)
                  throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException
Method call is used for initiating mobile originated voice calls. Terminal needs to be in service state for method call to be successful. Calls initiated with initiateCall are always voice calls. This method call is only allowed for devices attached physically to the terminal.

Parameters:
phoneNumber -
id -
Throws:
GeneralFailureException

answerCall

public void answerCall(int id)
                throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                       com.nokia.m2m.orb.idl.terminal.ETPackage.CallIDNotInUseException
Method call is used for answering to mobile terminated voice calls. This method call is only allowed for devices attached physically to the terminal.

Parameters:
id -
Throws:
GeneralFailureException
CallIDNotInUseException

dropCall

public void dropCall(int id)
              throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                     com.nokia.m2m.orb.idl.terminal.ETPackage.CallIDNotInUseException
Method call is used for dropping either mobile originated (MO) or mobile terminated (MT) calls. This method call is only allowed for devices attached physically to the terminal.

Parameters:
id -
Throws:
GeneralFailureException
CallIDNotInUseException

dropAllCalls

public void dropAllCalls()
Method call is used for dropping all calls active for the terminal. Calls can be mobile originated or mobile terminated calls and can be in any state. This method can be invoked over-the-air (OTA).

Throws:
GeneralFailureException

holdCall

public void holdCall(int id)
              throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                     com.nokia.m2m.orb.idl.terminal.ETPackage.CallIDNotInUseException
Method call is used for putting the call of choice to hold. Call has to be in active state. This method call is only allowed for devices attached physically to the terminal.

Parameters:
id -
Throws:
GeneralFailureException
CallIDNotInUseException

retrieveCall

public void retrieveCall(int id)
                  throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                         com.nokia.m2m.orb.idl.terminal.ETPackage.CallIDNotInUseException
Method call is used for retrieving a call on hold and activating it. This method call is only allowed for devices attached physically to the terminal.

Parameters:
id -
Throws:
GeneralFailureException
CallIDNotInUseException

joinCall

public void joinCall(int id)
              throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                     com.nokia.m2m.orb.idl.terminal.ETPackage.CallIDNotInUseException
Method call is used for joining active and calls on hold together and thus making a conference call. This method call is only allowed for devices attached physically to the terminal.

Parameters:
id -
Throws:
GeneralFailureException
CallIDNotInUseException

splitCall

public void splitCall(int id)
               throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                      com.nokia.m2m.orb.idl.terminal.ETPackage.CallIDNotInUseException
Method call is used for splitting one member from a conference call to a private call. After splitting the private call becomes active and the conference call is put on hold. This method call is only allowed for devices attached physically to the terminal.

Parameters:
id -
Throws:
GeneralFailureException
CallIDNotInUseException

transferCall

public void transferCall(int id)
                  throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                         com.nokia.m2m.orb.idl.terminal.ETPackage.CallIDNotInUseException
Method call is used for transferring an active call to another party that is on hold. This method call is only allowed for devices attached physically to the terminal.

Parameters:
id -
Throws:
GeneralFailureException
CallIDNotInUseException

swapCalls

public void swapCalls(int id)
               throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                      com.nokia.m2m.orb.idl.terminal.ETPackage.CallIDNotInUseException
Method call is used for swapping between an active call and a call on hold. This method call is only allowed for devices attached physically to the terminal.

Parameters:
id -
Throws:
GeneralFailureException
CallIDNotInUseException

generateDTMFTones

public void generateDTMFTones(String digits)
                       throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException
Parameters:
digits -
Throws:
com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException

createConnection

public byte createConnection(com.nokia.m2m.orb.idl.terminal.ETPackage.BearerInformation connectionData)
                      throws com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionParameterException
Method call is used for creating new connections. Connections are used for connecting the GSM Connectivity Terminal with the Nokia M2M Gateway using one of the bearers supported. A connection is created for each bearer that is to be used and after this the bearer can be changed by changing the connection with setConnection method call. This method call is only allowed for devices attached physically to the terminal. The created connection is dynamic.

Parameters:
connectionData - Connection specific bearer information.
Returns:
Method call was successful. Identifier is used in other connection control functions.
Throws:
ConnectionParameterException

setConnection

public byte setConnection(byte connectionId)
                   throws com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionIDNotInUseException
Method call is used for setting a connection created by createConnection to be used in the terminal. The setConnection is used for incoming connection sessions. This method call is only allowed for devices attached physically to the terminal.

Parameters:
connectionId -
Returns:
Throws:
ConnectionIDNotInUseException

closeConnection

public void closeConnection(byte connectionId)
                     throws com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionIDNotInUseException
Method call is used for closing a connection in use. Closing connections is not relevant if connections are used with SMS bearer. In data call bearer usage closeConnection drops an active data call. Same connection can still be used after dropping the call. This method call is only allowed for devices attached physically to the terminal.

Parameters:
connectionId -
Throws:
ConnectionIDNotInUseException

destroyConnection

public void destroyConnection(byte connectionId)
                       throws com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionIDNotInUseException
Method call is used for deleting connections from Nokia GSM Connectivity Terminal. Connections that are destroyed cannot be used for communication anymore and have to be created again. This method call is only allowed for devices attached physically to the terminal.

Parameters:
connectionId -
Throws:
ConnectionIDNotInUseException

sendSSCode

public boolean sendSSCode(String data)
                   throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException
Method call is used for sending supplementary service codes. This method call is only allowed for devices attached physically to the terminal.
Note It is not advisable to use supplementary service codes in changing PIN or PIN2 codes. ChangeSecurityCode method call must be used instead

Parameters:
data -
Returns:
Boolean value tells whether the service is active or not
Throws:
GeneralFailureException

setCallForwarding

public void setCallForwarding(com.nokia.m2m.orb.idl.terminal.ETPackage.CallForwardReason cfr,
                              String phoneNumber,
                              com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass[] ccl,
                              short time)
                       throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException
Method call is used for setting on call forwarding services. The terminal needs to be in service state when call forwarding is set. This method call is only allowed for devices attached physically to the terminal.

Parameters:
cfr -
phoneNumber -
ccl -
time -
Throws:
GeneralFailureException

removeCallForwarding

public void removeCallForwarding(com.nokia.m2m.orb.idl.terminal.ETPackage.CallForwardReason cfr,
                                 com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass[] ccl)
                          throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException
Method call is used for removing call-forwarding services provided by the GSM network. Terminal needs to be in service state when call forwarding is removed. This method call is only allowed for devices attached physically to the terminal.

Parameters:
cfr -
ccl -
Throws:
GeneralFailureException

getCallForwarding

public void getCallForwarding(com.nokia.m2m.orb.idl.terminal.ETPackage.CallForwardReason cfr,
                              org.omg.CORBA.StringHolder phoneNumber,
                              org.omg.CORBA.BooleanHolder active,
                              com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass cl,
                              org.omg.CORBA.ShortHolder time)
                       throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException
Method call is used for getting call forwarding service status from network. Terminal needs to be in service state when forwarding status is queried. Phone number and active status are returned only when the service is active as a whole. For example, if one makes a query using ALL_* values it is not enough if the call forwarding only applies to VOICE type. This method call is only allowed for devices attached physically to the terminal.

Parameters:
cfr -
phoneNumber -
active -
cl -
time -
Throws:
GeneralFailureException

setFacilityLock

public void setFacilityLock(com.nokia.m2m.orb.idl.terminal.ETPackage.FacilityType ft,
                            com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass[] ccl,
                            boolean locked,
                            String password)
                     throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException,
                            com.nokia.m2m.orb.idl.terminal.ETPackage.InvalidPasswordException
Method call is used for manipulating facility locks.

Parameters:
ft -
ccl -
locked -
password -
Throws:
InvalidPasswordException
GeneralFailureException

getFacilityLock

public void getFacilityLock(com.nokia.m2m.orb.idl.terminal.ETPackage.FacilityType ft,
                            com.nokia.m2m.orb.idl.terminal.ETPackage.ConnectionClass[] ccl,
                            org.omg.CORBA.BooleanHolder active)
                     throws com.nokia.m2m.orb.idl.terminal.ETPackage.GeneralFailureException
Method call is used for retrieving activity status of a facility lock of choice.

Parameters:
ft -
ccl -
active -
Throws:
GeneralFailureException

readPhonebookEntry

public void readPhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt,
                               int index,
                               org.omg.CORBA.StringHolder text,
                               org.omg.CORBA.StringHolder phoneNumber)
                        throws com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookFailureException
Reads an entry from the phonebook.

Throws:
PhonebookFailureException

findPhonebookEntry

public void findPhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt,
                               String text,
                               com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookEntryIndexListHolder pbeil)
                        throws com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookFailureException
Searches phonebook entries.

Throws:
PhonebookFailureException

editPhonebookEntry

public void editPhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt,
                               int index,
                               String text,
                               String phoneNumber)
                        throws com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookFailureException
Allows you to edit a phonebook entry.

Throws:
PhonebookFailureException

addPhonebookEntry

public void addPhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt,
                              String text,
                              String phoneNumber,
                              org.omg.CORBA.IntHolder index)
                       throws com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookFailureException
Adds a new entry to the phonebook.

Throws:
PhonebookFailureException

removePhonebookEntry

public void removePhonebookEntry(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt,
                                 int index)
                          throws com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookFailureException
Removes an entry from the phonebook.

Throws:
PhonebookFailureException

getPhonebookSize

public void getPhonebookSize(com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookType pbt,
                             org.omg.CORBA.IntHolder numberOfEntries,
                             org.omg.CORBA.IntHolder numberOfUsedEntries,
                             org.omg.CORBA.IntHolder numberLength,
                             org.omg.CORBA.IntHolder textLength)
                      throws com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookFailureException
Retrieves phonebook capacity and usage information.

Throws:
PhonebookSizeUnknownException
com.nokia.m2m.orb.idl.terminal.ETPackage.PhonebookFailureException


Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries. Copyright (c) 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.

Portions of this document are under the following copyright:
Copyright © 2003 Nokia. All rights reserved.