1 favouritesdbincremental.h

     1 /*

     2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of the License "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Declaration of RFavouritesDbIncremental

    15 *

    16 */

    17 

    18 

    19 #ifndef FAVOURITES_DB_INCREMENTAL_H

    20 #define FAVOURITES_DB_INCREMENTAL_H

    21 

    22 //  INCLUDES

    23 

    24 #include <FavouritesHandle.h>

    25 

    26 // FORWARD DECLARATIONS

    27 

    28 class RFavouritesDb;

    29 

    30 // CLASS DECLARATION

    31 

    32 /**

    33 * Incremental object for Favourites Engine.

    34 * This class provides incremental database administration (recovery,

    35 * compaction). Usually client does not need to use this class.

    36 */

    37 class RFavouritesDbIncremental: public RFavouritesHandle

    38     {

    39     public:     // update

    40 

    41         /**

    42         * Start incremental recovery on the given database.

    43         * @since 0.9 

    44         * @param aDb The database to be recovered.

    45         * @param aStep Placeholder for the step counter to be returned.

    46         * @return Error code.

    47         */

    48         IMPORT_C TInt Recover( RFavouritesDb& aDb, TInt& aStep );

    49 

    50         /**

    51         * Start incremental compaction on the given database.

    52         * @since 0.9 

    53         * @param aDb The database to be compacted.

    54         * @param aStep Placeholder for the step counter to be returned.

    55         * @return Error code.

    56         */

    57         IMPORT_C TInt Compact( RFavouritesDb& aDb, TInt& aStep );

    58 

    59         /**

    60         * Perform next step of incremental operation.

    61         * @since 0.9 

    62         * @param aStep Step counter.

    63         * @return Error code.

    64         */

    65         IMPORT_C TInt Next( TInt& aStep );

    66 

    67     };

    68 

    69 #endif

    70             

    71 // End of File