1 /*
2  * Copyright (c) 2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef DISTRIBUTEDDATAFWK_IDATA_SHARE_SERVICE_H
17 #define DISTRIBUTEDDATAFWK_IDATA_SHARE_SERVICE_H
18 
19 #include <iremote_broker.h>
20 #include <string>
21 
22 #include "datashare_predicates.h"
23 #include "datashare_result_set.h"
24 #include "datashare_values_bucket.h"
25 #include "datashare_template.h"
26 #include "data_proxy_observer.h"
27 #include "iremote_object.h"
28 
29 namespace OHOS::DataShare {
30 class IDataShareService {
31 public:
32     enum {
33         DATA_SHARE_SERVICE_CMD_INSERT,
34         DATA_SHARE_SERVICE_CMD_DELETE,
35         DATA_SHARE_SERVICE_CMD_UPDATE,
36         DATA_SHARE_SERVICE_CMD_QUERY,
37         DATA_SHARE_SERVICE_CMD_ADD_TEMPLATE,
38         DATA_SHARE_SERVICE_CMD_DEL_TEMPLATE,
39         DATA_SHARE_SERVICE_CMD_PUBLISH,
40         DATA_SHARE_SERVICE_CMD_GET_DATA,
41         DATA_SHARE_SERVICE_CMD_SUBSCRIBE_RDB,
42         DATA_SHARE_SERVICE_CMD_UNSUBSCRIBE_RDB,
43         DATA_SHARE_SERVICE_CMD_ENABLE_SUBSCRIBE_RDB,
44         DATA_SHARE_SERVICE_CMD_DISABLE_SUBSCRIBE_RDB,
45         DATA_SHARE_SERVICE_CMD_SUBSCRIBE_PUBLISHED,
46         DATA_SHARE_SERVICE_CMD_UNSUBSCRIBE_PUBLISHED,
47         DATA_SHARE_SERVICE_CMD_ENABLE_SUBSCRIBE_PUBLISHED,
48         DATA_SHARE_SERVICE_CMD_DISABLE_SUBSCRIBE_PUBLISHED,
49         DATA_SHARE_SERVICE_CMD_NOTIFY,
50         DATA_SHARE_SERVICE_CMD_NOTIFY_OBSERVERS,
51         DATA_SHARE_SERVICE_CMD_SET_SILENT_SWITCH,
52         DATA_SHARE_SERVICE_CMD_GET_SILENT_PROXY_STATUS,
53         DATA_SHARE_SERVICE_CMD_REGISTER_OBSERVER,
54         DATA_SHARE_SERVICE_CMD_UNREGISTER_OBSERVER,
55         DATA_SHARE_SERVICE_CMD_INSERTEX,
56         DATA_SHARE_SERVICE_CMD_DELETEEX,
57         DATA_SHARE_SERVICE_CMD_UPDATEEX,
58         DATA_SHARE_SERVICE_CMD_MAX
59     };
60 
61     enum { DATA_SHARE_ERROR = -1, DATA_SHARE_OK = 0 };
62     DECLARE_INTERFACE_DESCRIPTOR(u"OHOS.DataShare.IDataShareService");
63 
64     virtual int32_t Insert(const std::string &uri, const DataShareValuesBucket &valuesBucket) = 0;
65     virtual int32_t Update(const std::string &uri, const DataSharePredicates &predicate,
66         const DataShareValuesBucket &valuesBucket) = 0;
67     virtual int32_t Delete(const std::string &uri, const DataSharePredicates &predicate) = 0;
68     virtual std::pair<int32_t, int32_t> InsertEx(
69         const std::string &uri, const std::string &extUri, const DataShareValuesBucket &valuesBucket) = 0;
70     virtual std::pair<int32_t, int32_t> UpdateEx(const std::string &uri, const std::string &extUri,
71         const DataSharePredicates &predicate, const DataShareValuesBucket &valuesBucket) = 0;
72     virtual std::pair<int32_t, int32_t> DeleteEx(const std::string &uri, const std::string &extUri,
73         const DataSharePredicates &predicate) = 0;
74     virtual std::shared_ptr<DataShareResultSet> Query(const std::string &uri, const std::string &extUri,
75         const DataSharePredicates &predicates, const std::vector<std::string> &columns, int &errCode) = 0;
76     virtual int32_t AddTemplate(const std::string &uri, const int64_t subscriberId, const Template &tplt) = 0;
77     virtual int32_t DelTemplate(const std::string &uri, const int64_t subscriberId) = 0;
78     virtual std::vector<OperationResult> Publish(const Data &data, const std::string &bundleNameOfProvider) = 0;
79     virtual Data GetData(const std::string &bundleNameOfProvider, int &errorCode) = 0;
80     virtual std::vector<OperationResult> SubscribeRdbData(
81         const std::vector<std::string> &uris, const TemplateId &id, const sptr<IDataProxyRdbObserver> observer) = 0;
82     virtual std::vector<OperationResult> UnsubscribeRdbData(
83         const std::vector<std::string> &uris, const TemplateId &id) = 0;
84     virtual std::vector<OperationResult> EnableRdbSubs(
85         const std::vector<std::string> &uris, const TemplateId &id) = 0;
86     virtual std::vector<OperationResult> DisableRdbSubs(
87         const std::vector<std::string> &uris, const TemplateId &id) = 0;
88     virtual std::vector<OperationResult> SubscribePublishedData(const std::vector<std::string> &uris,
89         const int64_t subscriberId, const sptr<IDataProxyPublishedDataObserver> observer) = 0;
90     virtual std::vector<OperationResult> UnsubscribePublishedData(const std::vector<std::string> &uris,
91         const int64_t subscriberId) = 0;
92     virtual std::vector<OperationResult> EnablePubSubs(const std::vector<std::string> &uris,
93         const int64_t subscriberId) = 0;
94     virtual std::vector<OperationResult> DisablePubSubs(const std::vector<std::string> &uris,
95         const int64_t subscriberId) = 0;
96     virtual void OnConnectDone() = 0;
97     virtual void NotifyObserver(const std::string &uri) = 0;
98     virtual int32_t EnableSilentProxy(const std::string &uri, bool enable) = 0;
99     virtual int32_t GetSilentProxyStatus(const std::string &uri, bool isCreateHelper = true) = 0;
100     virtual int32_t RegisterObserver(const std::string &uri, const sptr<OHOS::IRemoteObject> &remoteObj) = 0;
101     virtual int32_t UnregisterObserver(const std::string &uri,
102         const sptr<OHOS::IRemoteObject> &remoteObj) = 0;
103 };
104 } // namespace OHOS::DataShare
105 #endif // DISTRIBUTEDDATAFWK_IDATA_SHARE_SERVICE_H
106