1.1 --- a/epoc32/include/mw/favouritesdbincremental.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/favouritesdbincremental.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,71 @@
     1.4 -favouritesdbincremental.h
     1.5 +/*
     1.6 +* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Eclipse Public License v1.0"
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Declaration of RFavouritesDbIncremental
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef FAVOURITES_DB_INCREMENTAL_H
    1.24 +#define FAVOURITES_DB_INCREMENTAL_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +
    1.28 +#include <FavouritesHandle.h>
    1.29 +
    1.30 +// FORWARD DECLARATIONS
    1.31 +
    1.32 +class RFavouritesDb;
    1.33 +
    1.34 +// CLASS DECLARATION
    1.35 +
    1.36 +/**
    1.37 +* Incremental object for Favourites Engine.
    1.38 +* This class provides incremental database administration (recovery,
    1.39 +* compaction). Usually client does not need to use this class.
    1.40 +*/
    1.41 +class RFavouritesDbIncremental: public RFavouritesHandle
    1.42 +    {
    1.43 +    public:     // update
    1.44 +
    1.45 +        /**
    1.46 +        * Start incremental recovery on the given database.
    1.47 +        * @since 0.9 
    1.48 +        * @param aDb The database to be recovered.
    1.49 +        * @param aStep Placeholder for the step counter to be returned.
    1.50 +        * @return Error code.
    1.51 +        */
    1.52 +        IMPORT_C TInt Recover( RFavouritesDb& aDb, TInt& aStep );
    1.53 +
    1.54 +        /**
    1.55 +        * Start incremental compaction on the given database.
    1.56 +        * @since 0.9 
    1.57 +        * @param aDb The database to be compacted.
    1.58 +        * @param aStep Placeholder for the step counter to be returned.
    1.59 +        * @return Error code.
    1.60 +        */
    1.61 +        IMPORT_C TInt Compact( RFavouritesDb& aDb, TInt& aStep );
    1.62 +
    1.63 +        /**
    1.64 +        * Perform next step of incremental operation.
    1.65 +        * @since 0.9 
    1.66 +        * @param aStep Step counter.
    1.67 +        * @return Error code.
    1.68 +        */
    1.69 +        IMPORT_C TInt Next( TInt& aStep );
    1.70 +
    1.71 +    };
    1.72 +
    1.73 +#endif
    1.74 +            
    1.75 +// End of File