ToiDiagnosticsDataModel Interface Reference

---

Description

Technical Preview:

This interface is a TECHNICAL PREVIEW, it may change. This interface represents the data model of all the diagnostics information present on the device.

import "ToiDiagnosticsDataModel.idl";

Inheritance diagram for ToiDiagnosticsDataModel:

List of all members.

Public Member Functions
ToiDiagnosticsDataModelObjectInfo	getObject (in TToiObjectIdentifier objectId) raises (TToiInvalidArgumentException)
void	setObject (in ToiDiagnosticsDataModelObjectInfo infoObject) raises (TToiInvalidArgumentException, TToiPermissionDeniedException)
void	subscribeObject (in ToiEventListener eventListener, in TToiObjectIdentifier objectId) raises (TToiInvalidArgumentException)
void	unsubscribeObject (in ToiEventListener eventListener, in TToiObjectIdentifier objectId) raises (TToiInvalidArgumentException)
void	releaseInstance ()
Public Attributes
Events
const long	ON_OBJECTS_CHANGED = 900
const long	ON_OBJECTS_ADDED = 901
const long	ON_OBJECTS_REMOVED = 902
Public Types
typedef string	TToiObjectIdentifier
typedef sequence < ToiDiagnosticsDataModelObjectParameter >	TToiObjectParameterSequence
typedef sequence < TToiObjectIdentifier >	TToiObjectIdentifierSequence
typedef sequence < ToiDiagnosticsDataModelObjectInfo >	TToiObjectInfoSequence

---

Member Typedef Documentation

typedef string ToiDiagnosticsDataModel::TToiObjectIdentifier

Identifier for an object in the Data Model.

typedef sequence< TToiObjectIdentifier > ToiDiagnosticsDataModel::TToiObjectIdentifierSequence

Sequence of object Identifiers.

typedef sequence< ToiDiagnosticsDataModelObjectInfo > ToiDiagnosticsDataModel::TToiObjectInfoSequence

Sequence of objects.

typedef sequence< ToiDiagnosticsDataModelObjectParameter > ToiDiagnosticsDataModel::TToiObjectParameterSequence

Sequence of parameters.

---

Member Function Documentation

ToiDiagnosticsDataModelObjectInfo ToiDiagnosticsDataModel::getObject

(

in TToiObjectIdentifier

objectId

)

raises (TToiInvalidArgumentException)

This function returns a ToiDiagnosticsDataModelObjectInfo corresponding to the given objectId.

Parameters:

objectId

The Id for the object

Return values:

infoObject

The ToiDiagnosticsDataModelObjectInfo representing that object in the data model.

Exceptions:

TToiInvalidArgumentException

Raised if the specified object identifier is invalid.

void ToiDiagnosticsDataModel::releaseInstance

(

)

This function releases the resources used by this instance. When this function returns all observers have also been released.

void ToiDiagnosticsDataModel::setObject

(

in ToiDiagnosticsDataModelObjectInfo

infoObject

)

raises (TToiInvalidArgumentException, TToiPermissionDeniedException)

This function is used to set the parameters of an object in the data model.

Parameters:

infoObject

The object containing new parameter values.

Exceptions:

TToiInvalidArgumentException	Raised if the specified object indentifier is invalid.
TToiPermissionDeniedException	Raised if the parameters of the data model object cannot be set.

void ToiDiagnosticsDataModel::subscribeObject	(	in ToiEventListener	eventListener,
		in TToiObjectIdentifier	objectId
	)		raises (TToiInvalidArgumentException)

This function is used to register a ToiDiagnosticsDataModelObserver with the diagnostics framework to be notified of any changes to an object in the data model.

Parameters:

eventListener	ToiEventListener
objectId	The object id that the application is interested in.

Exceptions:

TToiInvalidArgumentException

Raised if the specified object identifier is invalid.

See also:

ToiDiagnosticsDataModel::unsubscribeObject()

void ToiDiagnosticsDataModel::unsubscribeObject	(	in ToiEventListener	eventListener,
		in TToiObjectIdentifier	objectId
	)		raises (TToiInvalidArgumentException)

This function is used to unregister a previously registered ToiDiagnosticsDataModelObserver.

Parameters:

eventListener	ToiEventListener
objectId	The object id that the application is interested in.

Exceptions:

TToiInvalidArgumentException

Raised if the specified object identifier is invalid. Raised if the address is invalid.

See also:

ToiDiagnosticsDataModel::subscribeObject()

---

Member Data Documentation

const long ToiDiagnosticsDataModel::ON_OBJECTS_ADDED = 901

This is an Event identifier for ToiDiagnosticsDataModelObjectsAddedEvent.

This constant can also be accessed from toi.consts.ToiDiagnosticsDataModel.ON_OBJECTS_ADDED.

const long ToiDiagnosticsDataModel::ON_OBJECTS_CHANGED = 900

This is an Event identifier for ToiDiagnosticsDataModelObjectsChangedEvent.

This constant can also be accessed from toi.consts.ToiDiagnosticsDataModel.ON_OBJECTS_CHANGED.

const long ToiDiagnosticsDataModel::ON_OBJECTS_REMOVED = 902

This is an Event identifier for ToiDiagnosticsDataModelObjectsRemovedEvent.

This constant can also be accessed from toi.consts.ToiDiagnosticsDataModel.ON_OBJECTS_REMOVED.