|
williamr@2
|
1 |
/*
|
|
williamr@2
|
2 |
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
|
|
williamr@2
|
3 |
* All rights reserved.
|
|
williamr@2
|
4 |
* This component and the accompanying materials are made available
|
|
williamr@2
|
5 |
* under the terms of the License "Eclipse Public License v1.0"
|
|
williamr@2
|
6 |
* which accompanies this distribution, and is available
|
|
williamr@2
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
williamr@2
|
8 |
*
|
|
williamr@2
|
9 |
* Initial Contributors:
|
|
williamr@2
|
10 |
* Nokia Corporation - initial contribution.
|
|
williamr@2
|
11 |
*
|
|
williamr@2
|
12 |
* Contributors:
|
|
williamr@2
|
13 |
*
|
|
williamr@2
|
14 |
* Description: Declaration of RFavouritesDbIncremental
|
|
williamr@2
|
15 |
*
|
|
williamr@2
|
16 |
*/
|
|
williamr@2
|
17 |
|
|
williamr@2
|
18 |
|
|
williamr@2
|
19 |
#ifndef FAVOURITES_DB_INCREMENTAL_H
|
|
williamr@2
|
20 |
#define FAVOURITES_DB_INCREMENTAL_H
|
|
williamr@2
|
21 |
|
|
williamr@2
|
22 |
// INCLUDES
|
|
williamr@2
|
23 |
|
|
williamr@4
|
24 |
#include <favouriteshandle.h>
|
|
williamr@2
|
25 |
|
|
williamr@2
|
26 |
// FORWARD DECLARATIONS
|
|
williamr@2
|
27 |
|
|
williamr@2
|
28 |
class RFavouritesDb;
|
|
williamr@2
|
29 |
|
|
williamr@2
|
30 |
// CLASS DECLARATION
|
|
williamr@2
|
31 |
|
|
williamr@2
|
32 |
/**
|
|
williamr@2
|
33 |
* Incremental object for Favourites Engine.
|
|
williamr@2
|
34 |
* This class provides incremental database administration (recovery,
|
|
williamr@2
|
35 |
* compaction). Usually client does not need to use this class.
|
|
williamr@2
|
36 |
*/
|
|
williamr@2
|
37 |
class RFavouritesDbIncremental: public RFavouritesHandle
|
|
williamr@2
|
38 |
{
|
|
williamr@2
|
39 |
public: // update
|
|
williamr@2
|
40 |
|
|
williamr@2
|
41 |
/**
|
|
williamr@2
|
42 |
* Start incremental recovery on the given database.
|
|
williamr@2
|
43 |
* @since 0.9
|
|
williamr@2
|
44 |
* @param aDb The database to be recovered.
|
|
williamr@2
|
45 |
* @param aStep Placeholder for the step counter to be returned.
|
|
williamr@2
|
46 |
* @return Error code.
|
|
williamr@2
|
47 |
*/
|
|
williamr@2
|
48 |
IMPORT_C TInt Recover( RFavouritesDb& aDb, TInt& aStep );
|
|
williamr@2
|
49 |
|
|
williamr@2
|
50 |
/**
|
|
williamr@2
|
51 |
* Start incremental compaction on the given database.
|
|
williamr@2
|
52 |
* @since 0.9
|
|
williamr@2
|
53 |
* @param aDb The database to be compacted.
|
|
williamr@2
|
54 |
* @param aStep Placeholder for the step counter to be returned.
|
|
williamr@2
|
55 |
* @return Error code.
|
|
williamr@2
|
56 |
*/
|
|
williamr@2
|
57 |
IMPORT_C TInt Compact( RFavouritesDb& aDb, TInt& aStep );
|
|
williamr@2
|
58 |
|
|
williamr@2
|
59 |
/**
|
|
williamr@2
|
60 |
* Perform next step of incremental operation.
|
|
williamr@2
|
61 |
* @since 0.9
|
|
williamr@2
|
62 |
* @param aStep Step counter.
|
|
williamr@2
|
63 |
* @return Error code.
|
|
williamr@2
|
64 |
*/
|
|
williamr@2
|
65 |
IMPORT_C TInt Next( TInt& aStep );
|
|
williamr@2
|
66 |
|
|
williamr@2
|
67 |
};
|
|
williamr@2
|
68 |
|
|
williamr@2
|
69 |
#endif
|
|
williamr@2
|
70 |
|
|
williamr@2
|
71 |
// End of File
|