Symbian^3 Application Developer Library >

CSmlDataProvider Class Reference

class CSmlDataProvider : public CBase

ECom Data Provider interface.

Inherits from

Public Member Functions
~CSmlDataProvider ()
IMPORT_C void CheckServerFiltersL ( RPointerArray < CSyncMLFilter > &, TSyncMLFilterChangeInfo &)
IMPORT_C void CheckSupportedServerFiltersL (const CSmlDataStoreFormat &, RPointerArray < CSyncMLFilter > &, TSyncMLFilterChangeInfo &)
IMPORT_C const TDesC & DefaultStoreL ()
IMPORT_C void GenerateFieldFilterQueryL (const RPointerArray < CSyncMLFilter > &, TDes &, RPointerArray < CSmlDataProperty > &, TDesC &)
IMPORT_C HBufC * GenerateRecordFilterQueryLC (const RPointerArray < CSyncMLFilter > &, TSyncMLFilterMatchType , TDes &, TSyncMLFilterType &, TDesC &)
IMPORT_C TSmlDataProviderId Identifier ()
IMPORT_C CDesCArray * ListStoresLC ()
IMPORT_C CSmlDataProvider * NewL ( TSmlDataProviderId )
IMPORT_C CSmlDataStore * NewStoreInstanceLC ()
IMPORT_C void OnFrameworkEvent ( TSmlFrameworkEvent , TInt , TInt )
IMPORT_C const CSmlDataStoreFormat & StoreFormatL ()
IMPORT_C const RPointerArray < CSyncMLFilter > & SupportedServerFiltersL ()
IMPORT_C TBool SupportsOperation ( TUid )
Protected Member Functions
void DoCheckServerFiltersL ( RPointerArray < CSyncMLFilter > &, TSyncMLFilterChangeInfo &)
void DoCheckSupportedServerFiltersL (const CSmlDataStoreFormat &, RPointerArray < CSyncMLFilter > &, TSyncMLFilterChangeInfo &)
const TDesC & DoDefaultStoreL ()
void DoGenerateFieldFilterQueryL (const RPointerArray < CSyncMLFilter > &, TDes &, RPointerArray < CSmlDataProperty > &, TDesC &)
HBufC * DoGenerateRecordFilterQueryLC (const RPointerArray < CSyncMLFilter > &, TSyncMLFilterMatchType , TDes &, TSyncMLFilterType &, TDesC &)
CDesCArray * DoListStoresLC ()
CSmlDataStore * DoNewStoreInstanceLC ()
void DoOnFrameworkEvent ( TSmlFrameworkEvent , TInt , TInt )
const CSmlDataStoreFormat & DoStoreFormatL ()
const RPointerArray < CSyncMLFilter > & DoSupportedServerFiltersL ()
TBool DoSupportsOperation ( TUid )
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
TSmlDataProviderId iDPId
TUid iEComTag

Constructor & Destructor Documentation

~CSmlDataProvider()

IMPORT_C ~CSmlDataProvider ( ) [virtual]

Member Functions Documentation

CheckServerFiltersL(RPointerArray< CSyncMLFilter > &, TSyncMLFilterChangeInfo &)

IMPORT_C void CheckServerFiltersL ( RPointerArray < CSyncMLFilter > & aFilters,
TSyncMLFilterChangeInfo & aChangeInfo
)

This method updates dynamic filters up-to-date.

Parameters

RPointerArray < CSyncMLFilter > & aFilters The array that includes filters
TSyncMLFilterChangeInfo & aChangeInfo The change information about changes that data provider did

CheckSupportedServerFiltersL(const CSmlDataStoreFormat &, RPointerArray< CSyncMLFilter > &, TSyncMLFilterChangeInfo &)

IMPORT_C void CheckSupportedServerFiltersL ( const CSmlDataStoreFormat & aServerDataStoreFormat,
RPointerArray < CSyncMLFilter > & aFilters,
TSyncMLFilterChangeInfo & aChangeInfo
)

This method checks what filters are supported by server.

Parameters

const CSmlDataStoreFormat & aServerDataStoreFormat The store format of server
RPointerArray < CSyncMLFilter > & aFilters The array that includes filters
TSyncMLFilterChangeInfo & aChangeInfo The change information about changes that data provider did

DefaultStoreL()

IMPORT_C const TDesC & DefaultStoreL ( )

DoCheckServerFiltersL(RPointerArray< CSyncMLFilter > &, TSyncMLFilterChangeInfo &)

void DoCheckServerFiltersL ( RPointerArray < CSyncMLFilter > & aFilters,
TSyncMLFilterChangeInfo & aChangeInfo
) [protected, pure virtual]

Parameters

RPointerArray < CSyncMLFilter > & aFilters
TSyncMLFilterChangeInfo & aChangeInfo

DoCheckSupportedServerFiltersL(const CSmlDataStoreFormat &, RPointerArray< CSyncMLFilter > &, TSyncMLFilterChangeInfo &)

void DoCheckSupportedServerFiltersL ( const CSmlDataStoreFormat & aServerDataStoreFormat,
RPointerArray < CSyncMLFilter > & aFilters,
TSyncMLFilterChangeInfo & aChangeInfo
) [protected, pure virtual]

Parameters

const CSmlDataStoreFormat & aServerDataStoreFormat
RPointerArray < CSyncMLFilter > & aFilters
TSyncMLFilterChangeInfo & aChangeInfo

DoDefaultStoreL()

const TDesC & DoDefaultStoreL ( ) [protected, pure virtual]

DoGenerateFieldFilterQueryL(const RPointerArray< CSyncMLFilter > &, TDes &, RPointerArray< CSmlDataProperty > &, TDesC &)

void DoGenerateFieldFilterQueryL ( const RPointerArray < CSyncMLFilter > & aFilters,
TDes & aFilterMimeType,
RPointerArray < CSmlDataProperty > & aProperties,
TDesC & aStoreName
) [protected, pure virtual]

Parameters

const RPointerArray < CSyncMLFilter > & aFilters
TDes & aFilterMimeType
RPointerArray < CSmlDataProperty > & aProperties
TDesC & aStoreName

DoGenerateRecordFilterQueryLC(const RPointerArray< CSyncMLFilter > &, TSyncMLFilterMatchType, TDes &, TSyncMLFilterType &, TDesC &)

HBufC * DoGenerateRecordFilterQueryLC ( const RPointerArray < CSyncMLFilter > & aFilters,
TSyncMLFilterMatchType aMatch,
TDes & aFilterMimeType,
TSyncMLFilterType & aFilterType,
TDesC & aStoreName
) [protected, pure virtual]

Parameters

const RPointerArray < CSyncMLFilter > & aFilters
TSyncMLFilterMatchType aMatch
TDes & aFilterMimeType
TSyncMLFilterType & aFilterType
TDesC & aStoreName

DoListStoresLC()

CDesCArray * DoListStoresLC ( ) [protected, pure virtual]

DoNewStoreInstanceLC()

CSmlDataStore * DoNewStoreInstanceLC ( ) [protected, pure virtual]

DoOnFrameworkEvent(TSmlFrameworkEvent, TInt, TInt)

void DoOnFrameworkEvent ( TSmlFrameworkEvent ,
TInt aParam1,
TInt aParam2
) [protected, pure virtual]

Parameters

TSmlFrameworkEvent
TInt aParam1
TInt aParam2

DoStoreFormatL()

const CSmlDataStoreFormat & DoStoreFormatL ( ) [protected, pure virtual]

DoSupportedServerFiltersL()

const RPointerArray < CSyncMLFilter > & DoSupportedServerFiltersL ( ) [protected, pure virtual]

DoSupportsOperation(TUid)

TBool DoSupportsOperation ( TUid aOpId ) const [protected, pure virtual]

Parameters

TUid aOpId

GenerateFieldFilterQueryL(const RPointerArray< CSyncMLFilter > &, TDes &, RPointerArray< CSmlDataProperty > &, TDesC &)

IMPORT_C void GenerateFieldFilterQueryL ( const RPointerArray < CSyncMLFilter > & aFilters,
TDes & aFilterMimeType,
RPointerArray < CSmlDataProperty > & aProperties,
TDesC & aStoreName
)

This method generates a field filter query to be sent to the SyncML server for the provided filters. NOTE: this method isn't finalised - still thinking of a way to make it SyncML DS 1.2 independent

Parameters

const RPointerArray < CSyncMLFilter > & aFilters The filters to be used for the query generation
TDes & aFilterMimeType The mime type of the returned filter query
RPointerArray < CSmlDataProperty > & aProperties The field filter query to be sent to the SyncML server - empty if no field filter involved for this specific filter
TDesC & aStoreName The name of used store

GenerateRecordFilterQueryLC(const RPointerArray< CSyncMLFilter > &, TSyncMLFilterMatchType, TDes &, TSyncMLFilterType &, TDesC &)

IMPORT_C HBufC * GenerateRecordFilterQueryLC ( const RPointerArray < CSyncMLFilter > & aFilters,
TSyncMLFilterMatchType aMatch,
TDes & aFilterMimeType,
TSyncMLFilterType & aFilterType,
TDesC & aStoreName
)

This method generates a record filter query to be sent to the SyncML server for the provided filters.

Parameters

const RPointerArray < CSyncMLFilter > & aFilters The filters to be used for the query generation
TSyncMLFilterMatchType aMatch The filter match type to be used
TDes & aFilterMimeType The mime type of the returned filter query
TSyncMLFilterType & aFilterType
TDesC & aStoreName The name of used store

Identifier()

IMPORT_C TSmlDataProviderId Identifier ( ) const

ListStoresLC()

IMPORT_C CDesCArray * ListStoresLC ( )

NewL(TSmlDataProviderId)

IMPORT_C CSmlDataProvider * NewL ( TSmlDataProviderId aId ) [static]

Parameters

TSmlDataProviderId aId

NewStoreInstanceLC()

IMPORT_C CSmlDataStore * NewStoreInstanceLC ( )

OnFrameworkEvent(TSmlFrameworkEvent, TInt, TInt)

IMPORT_C void OnFrameworkEvent ( TSmlFrameworkEvent ,
TInt aParam1,
TInt aParam2
)

Parameters

TSmlFrameworkEvent
TInt aParam1
TInt aParam2

StoreFormatL()

IMPORT_C const CSmlDataStoreFormat & StoreFormatL ( )

SupportedServerFiltersL()

IMPORT_C const RPointerArray < CSyncMLFilter > & SupportedServerFiltersL ( )

This method returns the set of filters that can be used to send to the SyncML server.

SupportsOperation(TUid)

IMPORT_C TBool SupportsOperation ( TUid aOpId ) const

Parameters

TUid aOpId

Member Data Documentation

TSmlDataProviderId iDPId

TSmlDataProviderId iDPId [private]

TUid iEComTag

TUid iEComTag [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.