CSmlDataProvider Class Reference

#include <SmlDataProvider.h>

Link against: smldataprovider.lib

class CSmlDataProvider : public CBase

Inherits from

CSmlDataProvider

Public Member Functions
virtual	~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
pure virtual void	DoCheckServerFiltersL(RPointerArray< CSyncMLFilter > &, TSyncMLFilterChangeInfo &)
pure virtual void	DoCheckSupportedServerFiltersL(const CSmlDataStoreFormat &, RPointerArray< CSyncMLFilter > &, TSyncMLFilterChangeInfo &)
pure virtual const TDesC &	DoDefaultStoreL()
pure virtual void	DoGenerateFieldFilterQueryL(const RPointerArray< CSyncMLFilter > &, TDes &, RPointerArray< CSmlDataProperty > &, TDesC &)
pure virtual HBufC *	DoGenerateRecordFilterQueryLC(const RPointerArray< CSyncMLFilter > &, TSyncMLFilterMatchType, TDes &, TSyncMLFilterType &, TDesC &)
pure virtual CDesCArray *	DoListStoresLC()
pure virtual CSmlDataStore *	DoNewStoreInstanceLC()
pure virtual void	DoOnFrameworkEvent(TSmlFrameworkEvent, TInt, TInt)
pure virtual const CSmlDataStoreFormat &	DoStoreFormatL()
pure virtual const RPointerArray< CSyncMLFilter > &	DoSupportedServerFiltersL()
pure virtual 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()

Detailed Description

ECom Data Provider interface.

Constructor & Destructor Documentation

~CSmlDataProvider ( )

IMPORT_C

~CSmlDataProvider

(

)

[virtual]

Member Function Documentation

CheckServerFiltersL ( RPointerArray< CSyncMLFilter > &, TSyncMLFilterChangeInfo & )

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

This method updates dynamic filters up-to-date.

Parameter	Description
aFilters	The array that includes filters
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.

Parameter	Description
aServerDataStoreFormat	The store format of server
aFilters	The array that includes filters
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]

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

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

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]

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]

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]

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]

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

Parameter	Description
aFilters	The filters to be used for the query generation
aFilterMimeType	The mime type of the returned filter query
aProperties	The field filter query to be sent to the SyncML server - empty if no field filter involved for this specific filter
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.

Parameter	Description
aFilters	The filters to be used for the query generation
aMatch	The filter match type to be used
aFilterMimeType	The mime type of the returned filter query
aStoreName	The name of used store

Returns: The record filter query to be sent to the SyncML server - empty if no record filter involved for this specific filter