1 // Copyright 2010-2018, Google Inc.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 //     * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 //     * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 //     * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 
30 // UserDataManagerInterface is responsible for the management of the
31 // user data in the persistent storage, i.e. syncing, reloading, or
32 // clear-out.
33 
34 #ifndef MOZC_ENGINE_USER_DATA_MANAGER_INTERFACE_H_
35 #define MOZC_ENGINE_USER_DATA_MANAGER_INTERFACE_H_
36 
37 #include <string>
38 
39 #include "base/port_string.h"
40 
41 namespace mozc {
42 
43 class UserDataManagerInterface {
44  public:
45   virtual ~UserDataManagerInterface() = default;
46 
47   // Syncs mutable user data to local file system.
48   virtual bool Sync() = 0;
49 
50   // Reloads mutable user data from local file system.
51   virtual bool Reload() = 0;
52 
53   // Clears user history data.
54   virtual bool ClearUserHistory() = 0;
55 
56   // Clears user prediction data.
57   virtual bool ClearUserPrediction() = 0;
58 
59   // Clears unused user prediction data.
60   virtual bool ClearUnusedUserPrediction() = 0;
61 
62   // Clears a specific user prediction history.
63   virtual bool ClearUserPredictionEntry(
64       const string &key, const string &value) = 0;
65 
66   // Waits for syncer thread to complete.
67   virtual bool Wait() = 0;
68 };
69 
70 }  // namespace mozc
71 
72 #endif  // MOZC_ENGINE_USER_DATA_MANAGER_INTERFACE_H_
73