williamr@2: /*
williamr@2: * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Declaration of RFavouritesDbIncremental
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef FAVOURITES_DB_INCREMENTAL_H
williamr@2: #define FAVOURITES_DB_INCREMENTAL_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: 
williamr@2: #include <FavouritesHandle.h>
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: 
williamr@2: class RFavouritesDb;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2: * Incremental object for Favourites Engine.
williamr@2: * This class provides incremental database administration (recovery,
williamr@2: * compaction). Usually client does not need to use this class.
williamr@2: */
williamr@2: class RFavouritesDbIncremental: public RFavouritesHandle
williamr@2:     {
williamr@2:     public:     // update
williamr@2: 
williamr@2:         /**
williamr@2:         * Start incremental recovery on the given database.
williamr@2:         * @since 0.9 
williamr@2:         * @param aDb The database to be recovered.
williamr@2:         * @param aStep Placeholder for the step counter to be returned.
williamr@2:         * @return Error code.
williamr@2:         */
williamr@2:         IMPORT_C TInt Recover( RFavouritesDb& aDb, TInt& aStep );
williamr@2: 
williamr@2:         /**
williamr@2:         * Start incremental compaction on the given database.
williamr@2:         * @since 0.9 
williamr@2:         * @param aDb The database to be compacted.
williamr@2:         * @param aStep Placeholder for the step counter to be returned.
williamr@2:         * @return Error code.
williamr@2:         */
williamr@2:         IMPORT_C TInt Compact( RFavouritesDb& aDb, TInt& aStep );
williamr@2: 
williamr@2:         /**
williamr@2:         * Perform next step of incremental operation.
williamr@2:         * @since 0.9 
williamr@2:         * @param aStep Step counter.
williamr@2:         * @return Error code.
williamr@2:         */
williamr@2:         IMPORT_C TInt Next( TInt& aStep );
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: #endif
williamr@2:             
williamr@2: // End of File