Collapse all Symbian^3 Application Developer Library

CCatalogsEngine Class Reference

class CCatalogsEngine : public CBase

A factory interface class for creating an instance of Catalogs Engine API.

ncdengine_20019119.lib

Inherits from

CCatalogsEngine
- CBase

Public Member Functions
	~CCatalogsEngine ()
IMPORT_C void	EndMaintenanceL ()
IMPORT_C CCatalogsEngine *	NewL (MCatalogsEngineObserver &)
IMPORT_C CCatalogsEngine *	NewLC (MCatalogsEngineObserver &)
IMPORT_C void	StartMaintenanceL ()
IMPORT_C TState	StateL ()

Protected Member Functions
	CCatalogsEngine ()

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()

Public Member Enumerations
enum	TState { EStateNormal , EStatePrepareMaintenance , EStateMaintenance }

Private Attributes
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

CCatalogsEngine()

CCatalogsEngine

(

)

[protected]

Default constructor

Constructor

~CCatalogsEngine()

~CCatalogsEngine

(

)

[virtual]

Destructor.

Destructor

Member Functions Documentation

EndMaintenanceL()

IMPORT_C void

EndMaintenanceL

(

)

[static]

Ends engine maintenance. Engine usage is allowed.

Exceptions

KCatalogsErrorMaintenanceNotStarted	Client has not started maintenance.
Leave	System wide error code.

NewL(MCatalogsEngineObserver &)

IMPORT_C CCatalogsEngine *

NewL

(

MCatalogsEngineObserver &

aObserver

)

[static]

Instantiates the catalogs engine.

Parameters

MCatalogsEngineObserver & aObserver

Observer interface for the Catalogs Engine.

NewLC(MCatalogsEngineObserver &)

IMPORT_C CCatalogsEngine *

NewLC

(

MCatalogsEngineObserver &

aObserver

)

[static]

Instantiates the catalogs engine, leaves pointer on cleanup stack.

Parameters

MCatalogsEngineObserver & aObserver

Observer interface for the Catalogs Engine.

StartMaintenanceL()

IMPORT_C void

StartMaintenanceL

(

)

[static]

Starts engine maintenance. All clients with open references to the engine will receive a callback (MCatalogsEngineObserver::CatalogsEngineShutdown()) requesting release of engine objects. Also, further engine instantiations are refused for other clients until EndMaintenanceL() is called by the client that initiated the update in the first place.

Note:

The client calling StartMaintenanceL() may itself receive a callback for engine shutdown if it has open references to the Catalogs Engine. In this case, the client must obey the callback, like all other clients, and release the references.

Reaching maintenance state can be observed by polling engine state with State().

Exceptions

KCatalogsErrorMaintenanceNotAuthorized	Client is not authorized to start maintenance on engine.
Leave	System wide error code.

StateL()

IMPORT_C TState

StateL

(

)

[static]

Returns the Catalogs Engine state.

Member Enumerations Documentation

Enum TState

Catalogs Engine state.

Enumerators

EStateNormal	Normal state, engine object instantiation allowed
EStatePrepareMaintenance	Going to maintenance mode. Engine instantiation not allowed, but instances still exist.
EStateMaintenance	Maintenance mode. No Catalogs Engine instances exist, new ones not allowed.

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]