CPbk2StoreManager Class Reference

class CPbk2StoreManager : public CBase

Phonebook 2 store manager. The responsibilities of this class are to retrieve and observer the device contact store configuration and to open these stores through the Virtual Phonebook contact manager. It also manages the compression of the contact stores.

Inherits from

Public Member Functions
~CPbk2StoreManager()
CVPbkContactStoreUriArray *CurrentlyValidShownStoresL()
CVPbkContactStoreUriArray *CurrentlyValidStoresL()
voidDeregisterStoreEvents(const MVPbkContactStoreObserver &)
IMPORT_C voidEnableCompression(TBool)
IMPORT_C voidEnsureCurrentConfigurationStoresIncludedL()
IMPORT_C voidEnsureDefaultSavingStoreIncludedL()
IMPORT_C CPbk2StoreManager *NewL(CVPbkContactManager &, CPbk2StoreConfiguration &, TBool)
IMPORT_C voidOpenStoresL()
voidRegisterStoreEventsL(const MVPbkContactStoreObserver &)
Private Member Functions
CPbk2StoreManager(CVPbkContactManager &, CPbk2StoreConfiguration &, TBool)
voidCloseUnnecessaryStoresL()
voidConfigurationChanged()
voidConfigurationChangedComplete()
voidConstructL()
voidEnsureCurrentConfigurationLoadedAndOpenL()
voidHandleConfigurationChangedL()
voidHandleSavingStoreChangedL()
voidHandleStoreEventL(MVPbkContactStore &, TVPbkContactStoreEvent)
TBool IsStoreOpen(MVPbkContactStore &)
voidOpenComplete()
voidReplaceStoreL(MVPbkContactStore &)
voidSavingStoreChanged()
voidStoreReady(MVPbkContactStore &)
voidStoreUnavailable(MVPbkContactStore &, TInt)
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
TBool iActOnConfigurationEvents
MPbk2CompressPolicyManager *iCompressPolicy
CVPbkContactManager &iContactManager
MVPbkContactStoreList *iContactStores
RPointerArray< MVPbkContactStore >iFailedStores
RPointerArray< MVPbkContactStore >iOpenedStores
CPbk2StoreConfiguration &iStoreConfiguration
RPointerArray< MVPbkContactStoreObserver >iStoreObservers

Constructor & Destructor Documentation

CPbk2StoreManager(CVPbkContactManager &, CPbk2StoreConfiguration &, TBool)

CPbk2StoreManager(CVPbkContactManager &aContactManager,
CPbk2StoreConfiguration &aStoreConfiguration,
TBoolaActOnConfigurationEvents
)[private, inline]

Parameters

CVPbkContactManager & aContactManager
CPbk2StoreConfiguration & aStoreConfiguration
TBool aActOnConfigurationEvents

~CPbk2StoreManager()

~CPbk2StoreManager()

Destructor.

Member Functions Documentation

CloseUnnecessaryStoresL()

voidCloseUnnecessaryStoresL()[private]

ConfigurationChanged()

voidConfigurationChanged()[private]

ConfigurationChangedComplete()

voidConfigurationChangedComplete()[private]

ConstructL()

voidConstructL()[private, inline]

CurrentlyValidShownStoresL()

CVPbkContactStoreUriArray *CurrentlyValidShownStoresL()const

CurrentlyValidStoresL()

CVPbkContactStoreUriArray *CurrentlyValidStoresL()const

DeregisterStoreEvents(const MVPbkContactStoreObserver &)

voidDeregisterStoreEvents(const MVPbkContactStoreObserver &aObserver)

Parameters

const MVPbkContactStoreObserver & aObserver

EnableCompression(TBool)

IMPORT_C voidEnableCompression(TBoolaEnable)

Enables and disables compression.

Parameters

TBool aEnableIndicates whether to enable or disable compression.

EnsureCurrentConfigurationLoadedAndOpenL()

voidEnsureCurrentConfigurationLoadedAndOpenL()[private]

EnsureCurrentConfigurationStoresIncludedL()

IMPORT_C voidEnsureCurrentConfigurationStoresIncludedL()

Ensures current configuation stores are loaded

EnsureDefaultSavingStoreIncludedL()

IMPORT_C voidEnsureDefaultSavingStoreIncludedL()

Ensures default saving store is loaded

HandleConfigurationChangedL()

voidHandleConfigurationChangedL()[private]

HandleSavingStoreChangedL()

voidHandleSavingStoreChangedL()[private]

HandleStoreEventL(MVPbkContactStore &, TVPbkContactStoreEvent)

voidHandleStoreEventL(MVPbkContactStore &aContactStore,
TVPbkContactStoreEventaEvent
)[private]

Parameters

MVPbkContactStore & aContactStore
TVPbkContactStoreEvent aEvent

IsStoreOpen(MVPbkContactStore &)

TBool IsStoreOpen(MVPbkContactStore &aContactStore)const [private]

Parameters

MVPbkContactStore & aContactStore

NewL(CVPbkContactManager &, CPbk2StoreConfiguration &, TBool)

IMPORT_C CPbk2StoreManager *NewL(CVPbkContactManager &aContactManager,
CPbk2StoreConfiguration &aStoreConfiguration,
TBoolaActOnConfigurationEvents
)[static]

Creates a new instance of this class.

Parameters

CVPbkContactManager & aContactManagerVirtual Phonebook contact manager.
CPbk2StoreConfiguration & aStoreConfigurationContact store configuration.
TBool aActOnConfigurationEventsIndicates whether to act on configuration events.

OpenComplete()

voidOpenComplete()[private]

OpenStoresL()

IMPORT_C voidOpenStoresL()

Opens all the contact stores that are loaded by Virtual Phonebook contact manager.

RegisterStoreEventsL(const MVPbkContactStoreObserver &)

voidRegisterStoreEventsL(const MVPbkContactStoreObserver &aObserver)

Parameters

const MVPbkContactStoreObserver & aObserver

ReplaceStoreL(MVPbkContactStore &)

voidReplaceStoreL(MVPbkContactStore &aContactStore)[private]

Parameters

MVPbkContactStore & aContactStore

SavingStoreChanged()

voidSavingStoreChanged()[private]

StoreReady(MVPbkContactStore &)

voidStoreReady(MVPbkContactStore &aContactStore)[private]

Parameters

MVPbkContactStore & aContactStore

StoreUnavailable(MVPbkContactStore &, TInt)

voidStoreUnavailable(MVPbkContactStore &aContactStore,
TIntaReason
)[private]

Parameters

MVPbkContactStore & aContactStore
TInt aReason

Member Data Documentation

TBool iActOnConfigurationEvents

TBool iActOnConfigurationEvents[private]

MPbk2CompressPolicyManager * iCompressPolicy

MPbk2CompressPolicyManager *iCompressPolicy[private]

CVPbkContactManager & iContactManager

CVPbkContactManager &iContactManager[private]

MVPbkContactStoreList * iContactStores

MVPbkContactStoreList *iContactStores[private]

RPointerArray< MVPbkContactStore > iFailedStores

RPointerArray< MVPbkContactStore >iFailedStores[private]

RPointerArray< MVPbkContactStore > iOpenedStores

RPointerArray< MVPbkContactStore >iOpenedStores[private]

CPbk2StoreConfiguration & iStoreConfiguration

CPbk2StoreConfiguration &iStoreConfiguration[private]

RPointerArray< MVPbkContactStoreObserver > iStoreObservers

RPointerArray< MVPbkContactStoreObserver >iStoreObservers[private]