MNcdServerReportManager Class Reference

class MNcdServerReportManager : public MCatalogsBase

MNcdServerReportManager interface provides functions that can be used to manage server report sending to the server. As a default, report sending is handled automatically in the background. But, manager can be used if reports should be collected and sent in certain moments. This interface can be gotten from the MNcdProvider by using the QueryInterfaceL function.

Note:

Capabilities define what kind of reports are supported by the application. So, if reports should or should not be sent, then define this by setting correct capabilities.

MNcdServerReportOperation MNcdServerReportOperationObserver MNcdProvider NcdCapabilities

Inherits from

Constructor & Destructor Documentation

~MNcdServerReportManager()

~MNcdServerReportManager ( ) [protected, inline, virtual]

The destructor of an interface is set virtual to make sure that the destructors of derived classes are called appropriately when the object is destroyed.

Destructor is defined as protected to prevent direct use of delete on observer interface pointers.

Member Functions Documentation

ReportingMethodL()

TReportingMethod ReportingMethodL ( ) const [pure virtual]

Getter for the reporting method.

ReportingStyleL()

TReportingStyle ReportingStyleL ( ) const [pure virtual]

Getter for the reporting style.

SendL(MNcdServerReportOperationObserver &)

MNcdServerReportOperation * SendL ( MNcdServerReportOperationObserver & aObserver ) [pure virtual]

Starts the server report sending operation.

Note:

The reference count of the operation object is increased by one. So, Release() function of the operation should be called when operation is not needed anymore.

The sending process is asynchronous. When sending has completed, the observer callback functions are called.

After sending is finished the collected reports will be automatically removed.

This function has an effect only if the reporting method is set to EReportingManaged. If reporting is done in the background, then reports are sent automatically, and NULL is returned for the operation.

Exceptions
Leave

System wide error code

Parameters

MNcdServerReportOperationObserver & aObserver Operation observer.

SetReportingMethodL(const TReportingMethod &)

void SetReportingMethodL ( const TReportingMethod & aMethod ) [pure virtual]

Setter for the reporting method.

Exceptions
Leave

System wide error code

Parameters

const TReportingMethod & aMethod The reporting method that is used when reports are managed.

SetReportingStyleL(const TReportingStyle &)

void SetReportingStyleL ( const TReportingStyle & aStyle ) [pure virtual]

Setter for the reporting style.

Exceptions
Leave

System wide error code

Parameters

const TReportingStyle & aStyle The style that is used for reports.

Member Enumerations Documentation

Enum TReportingMethod

Reporting method describes how the reporting is done.

Enumerators

EReportingBackground

Reporting is done in the background This is a default method.

EReportingManaged

Reporting is managed through this API Interface. The API user decides when to send reports instead of allowing reports to be sent in the background when process time allows.

Enum TReportingStyle

Enumerators

EReportingStyleGeneral

Reporting information is sent in the general format not in some platform specific format. This is a default value.

EReportingStyleS60

Reports will contain S60 specific information.