sync/internal_api/public/delete_journal.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef SYNC_INTERNAL_API_PUBLIC_DELETE_JOURNAL_H_
   6 #define SYNC_INTERNAL_API_PUBLIC_DELETE_JOURNAL_H_
   7
   8 #include <vector>
   9
  10 #include "sync/base/sync_export.h"
  11 #include "sync/internal_api/public/base/model_type.h"
  12 #include "sync/protocol/sync.pb.h"
  13
  14 namespace syncer {
  15
  16 class BaseTransaction;
  17
  18 struct BookmarkDeleteJournal {
  19   int64 id;   // Metahandle of delete journal entry.
  20   int64 external_id;  // Bookmark ID in the native model.
  21   bool is_folder;
  22   sync_pb::EntitySpecifics specifics;
  23 };
  24 typedef std::vector<BookmarkDeleteJournal> BookmarkDeleteJournalList;
  25
  26 // Static APIs for passing delete journals between syncer::syncable namspace
  27 // and syncer namespace.
  28 class SYNC_EXPORT DeleteJournal {
  29  public:
  30   // Return info about deleted bookmark entries stored in the delete journal
  31   // of |trans|'s directory.
  32   // TODO(haitaol): remove this after SyncData supports bookmarks and
  33   //                all types of delete journals can be returned as
  34   //                SyncDataList.
  35   static void GetBookmarkDeleteJournals(
  36       BaseTransaction* trans, BookmarkDeleteJournalList *delete_journals);
  37
  38   // Purge delete journals of given IDs from |trans|'s directory.
  39   static void PurgeDeleteJournals(BaseTransaction* trans,
  40                                   const std::set<int64>& ids);
  41 };
  42
  43 }  // namespace syncer
  44
  45 #endif  // SYNC_INTERNAL_API_PUBLIC_DELETE_JOURNAL_H_