com.nokia.m2m.orb.idl.wirelessdevice
Interface DeviceOperations

All Known Subinterfaces:

ETOperations

public interface DeviceOperations

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

• Device

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 interface for compatibility, but they will not implement any functionality. The following methods are supported both by the Nokia 12 GSM module and the Nokia 12 IMP 1.0 Concept Simulator:

• getDeviceInfo
• getObjectNames
• getObjectRef
• getObjectRefList
• getParam
• setParam
• getParamList
• setParamList

Properties supported by the Nokia 12 IMP 1.0 Concept Simulator in the getParam, setParam, getParamList and setParamList methods are:

• Date
• Time
• SignalQuality
• WAPParametersAuthentication

Method Summary

void	getCounter(com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.Counter c, org.omg.CORBA.IntHolder value) Method call is used for retrieving counter values.
void	getCounterList(com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.Counter[] c, com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.CounterValueListHolder values) Method call is used for retrieving a list of counter values.
void	getDeviceInfo(org.omg.CORBA.StringHolder hwManufacturer, org.omg.CORBA.StringHolder hwProductName, com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.VersionHolder hwVersion, org.omg.CORBA.StringHolder swManufacturer, org.omg.CORBA.StringHolder swProductName, com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.VersionHolder swVersion, com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.MetadataListHolder metadata) Method call returns information from a device supported by the simulator.
String[]	getObjectNames() Method call returns a list of object names.
org.omg.CORBA.Object	getObjectRef(String name) Method call returns object reference to wanted object.
org.omg.CORBA.Object[]	getObjectRefList(String[] names) Method call returns a list of object references to wanted objects.
void	getParam(String name, org.omg.CORBA.AnyHolder value) Method call is used for retrieving parameter values.
void	getParamList(String[] pnl, com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.ParamValueListHolder pvl) Method call is used for retrieving multiple parameter values.
void	removeAllObservers() Removes all observers.
void	removeEventObserver(String name, com.nokia.m2m.orb.idl.wirelessdevice.EventObserver o) Method call is used for cancelling event observer.
void	removeParamObserver(String name, com.nokia.m2m.orb.idl.wirelessdevice.ParamObserver po) Method call is used for cancelling parameter observer.
void	reset() Method call is used for resetting the device.
void	setEventObserver(String name, com.nokia.m2m.orb.idl.wirelessdevice.EventObserver o) Method call is used for registering event observer.
void	setParam(String name, org.omg.CORBA.Any value) Method call is used for modifying parameter values of the terminal.
void	setParamList(String[] pnl, org.omg.CORBA.Any[] pvl) Method call is used for modifying multiple parameter values.
void	setParamObserver(String name, com.nokia.m2m.orb.idl.wirelessdevice.ParamObserver po) Method call is used for registering parameter observer.

Method Detail

getObjectRef

public org.omg.CORBA.Object getObjectRef(String name)
                                  throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.UnknownObjectNameException

Method call returns object reference to wanted object. Name can be fetched with getObjectNames method call. This method call is intended to be used only in devices physically attached to the Nokia GSM Connectivity Terminal.

Parameters:

name - Defines name of the wanted object.

Returns:

A reference to an object.

Throws:

UnknownObjectNameException - used for indicating invalid object name in getObjectRef method call.

getObjectRefList

public org.omg.CORBA.Object[] getObjectRefList(String[] names)
                                        throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.UnknownObjectNameListException

Method call returns a list of object references to wanted objects. This method call is intended to be used only in devices physically attached to the Nokia GSM Connectivity Terminal.

Parameters:

names - Defines the list of object names queried.

Returns:

The queried objects.

Throws:

UnknownObjectNameListException - used for indicating the first invalid object name in getObjectRefList method call. Index will contain reference to the first invalid object name.

getObjectNames

public String[] getObjectNames()

Method call returns a list of object names. This method call is usually used together with getObjectRef.

Returns:

An array of object names running in the ORB module.

getDeviceInfo

public void getDeviceInfo(org.omg.CORBA.StringHolder hwManufacturer,
                          org.omg.CORBA.StringHolder hwProductName,
                          com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.VersionHolder hwVersion,
                          org.omg.CORBA.StringHolder swManufacturer,
                          org.omg.CORBA.StringHolder swProductName,
                          com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.VersionHolder swVersion,
                          com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.MetadataListHolder metadata)

Method call returns information from a device supported by the simulator.

Parameters:

hwManufacturer - Holder object for obtaining device manufacturer information.

hwProductName - Holder object for obtaining product name information.

hwVersion - Holder object for obtaining minor and major version number information from the device.

swManufacturer - Holder object for obtaining software manufacturer name information.

swProductName - Holder object for obtaining software name information.

swVersion - Holder object for obtaining minor and major version number information from the software.

metadata - Holder object for device specific metadata.

setParam

public void setParam(String name,
                     org.omg.CORBA.Any value)
              throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.ParamFailureException

Method call is used for modifying parameter values of the terminal. Note that some parameters require special conditions like service state and inserted SIM card. Refer to Nokia GSM Connectivity Terminal Parameter Reference Guide for parameters that can be set using this function.

Parameters:

name - Name of the modified parameter.

value - New value for wanted parameter. Any type value can be created using classes generated from properties.idl.

Throws:

ParamFailureException - Used for indicating failure in parameter handling. It can be sent as a response either to setParam or getParam method calls.

getParam

public void getParam(String name,
                     org.omg.CORBA.AnyHolder value)
              throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.ParamFailureException

Method call is used for retrieving parameter values. Note that some parameters require special conditions like service state and inserted SIM card. Refer to Nokia GSM Connectivity Terminal Parameter Reference Guide for parameters that can be get using this function.

Parameters:

name - Name of the retrieved parameter

value - Retrieved parameter value. Any type value can be created using classes generated from properties.idl.

Throws:

ParamFailureException - Used for indicating failure in parameter handling. It can be sent as a response either to setParam or getParam method calls.

setParamList

public void setParamList(String[] pnl,
                         org.omg.CORBA.Any[] pvl)
                  throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.ParamFailureListException

Method call is used for modifying multiple parameter values. Note that some parameters require special conditions like service state and inserted SIM card. Refer to Nokia GSM Connectivity Terminal Parameter Reference Guide for parameters that can be set using this function.

Parameters:

pnl - List of parameter names to be modified. Given as a sequence of strings.

pvl - New values for parameters. Given as a sequence of parameters of the type any. ‘Any’ type value can be created using classes generated from properties.idl.

Throws:

ParamFailureListException - Setting new values for parameters was not successful. First parameter that was not successful is returned in the exception.

getParamList

public void getParamList(String[] pnl,
                         com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.ParamValueListHolder pvl)
                  throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.ParamFailureListException

Method call is used for retrieving multiple parameter values. Note that some parameters require special conditions like service state and an inserted Subscriber Identity Module (SIM) card. Refer to Nokia GSM Connectivity Terminal Parameter Reference Guide for parameters that can be get using this function.

Parameters:

pnl - List of parameter names to be retrieved. Given as a sequence of strings.

pvl - List of retrieved parameter values. Given as a sequence of parameters of the type any. ‘Any’ type value can be created using classes generated from properties.idl.

Throws:

ParamFailureListException

setParamObserver

public void setParamObserver(String name,
                             com.nokia.m2m.orb.idl.wirelessdevice.ParamObserver po)
                      throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.UnknownParamNameException,
                             com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.ParamAlreadyObservedException

Method call is used for registering parameter observer. Additional parameters can be registered to same observer object with different name. Please see Nokia GSM Connectivity Terminal Parameter Reference Guide for parameter possibilities. This method call is only allowed for devices attached physically to the terminal. One parameter can have more that one observer registered.

Parameters:

name -

po -

Throws:

UnknownParamNameException

ParamAlreadyObservedException

removeParamObserver

public void removeParamObserver(String name,
                                com.nokia.m2m.orb.idl.wirelessdevice.ParamObserver po)
                         throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.UnknownParamNameException,
                                com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.ParamObserverNotExistsException

Method call is used for cancelling parameter observer. The whole observer is not removed until all parameters are cancelled. Please see Nokia GSM Connectivity Terminal Parameter Reference Guide for parameter possibilities. This method call is only allowed for devices attached physically to the terminal.

Parameters:

name -

po -

Throws:

UnknownParamNameException

ParamObserverNotExistsException

getCounter

public void getCounter(com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.Counter c,
                       org.omg.CORBA.IntHolder value)
                throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.UnknownCounterNameException

Method call is used for retrieving counter values. Counters can also be reset if counter is of a correct type. Please see Nokia GSM Connectivity Terminal Parameter Description for counter names and reset possibilities.

Parameters:

c -

value -

Throws:

UnknownCounterNameException

getCounterList

public void getCounterList(com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.Counter[] c,
                           com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.CounterValueListHolder values)
                    throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.UnknownCounterNameListException

Method call is used for retrieving a list of counter values. Counters can also be reset if counters are of correct type. Please see Nokia GSM Connectivity Terminal Parameter Reference Guide for counter names and reset possibilities.

Parameters:

c -

values -

Throws:

UnknownCounterNameListException

setEventObserver

public void setEventObserver(String name,
                             com.nokia.m2m.orb.idl.wirelessdevice.EventObserver o)
                      throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.EventNotExistsException

Method call is used for registering event observer. Additional events can be registered to same observer object with different name. Please see Nokia GSM Connectivity Terminal Parameter Reference Guide for event possibilities. This method call is only allowed for devices attached physically to the terminal.

Parameters:

name -

o -

Throws:

EventNotExistsException

removeEventObserver

public void removeEventObserver(String name,
                                com.nokia.m2m.orb.idl.wirelessdevice.EventObserver o)
                         throws com.nokia.m2m.orb.idl.wirelessdevice.DevicePackage.EventObserverNotExistsException

Method call is used for cancelling event observer. The whole observer is not removed until all events are cancelled. Please see Nokia GSM Connectivity Terminal Parameter Reference Guide for event possibilities. This method call is only allowed for devices attached physically to the terminal.

Parameters:

name -

o -

Throws:

EventObserverNotExistsException

removeAllObservers

public void removeAllObservers()

Removes all observers.

reset

public void reset()

Method call is used for resetting the device. There may be a short delay between the method call and actual reset procedures. Reset equals to switch-off: calls are disconnected but all the settings remain unchanged.