Mercurial > hg > orthanc-databases
annotate Framework/Plugins/IDatabaseBackend.h @ 366:cd9521e04249 attach-custom-data
DatabaseBackendAdapterV4: added support for customData + revision when not already done
| author | Alain Mazy <am@osimis.io> |
|---|---|
| date | Thu, 15 Sep 2022 18:12:34 +0200 |
| parents | 34e2b93a7ac1 |
| children |
| rev | line source |
|---|---|
| 202 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
| 5 * Copyright (C) 2017-2021 Osimis S.A., Belgium | |
| 6 * | |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU Affero General Public License | |
| 9 * as published by the Free Software Foundation, either version 3 of | |
| 10 * the License, or (at your option) any later version. | |
| 11 * | |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 15 * Affero General Public License for more details. | |
| 16 * | |
| 17 * You should have received a copy of the GNU Affero General Public License | |
| 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 **/ | |
| 20 | |
| 21 | |
| 22 | |
| 23 #pragma once | |
| 24 | |
| 25 #include "IDatabaseBackendOutput.h" | |
|
207
d9ef3f16e6a2
wrapping transactions in API v3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
203
diff
changeset
|
26 #include "../Common/DatabasesEnumerations.h" |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
27 #include "../Common/DatabaseManager.h" |
| 202 | 28 |
| 29 #include <list> | |
| 30 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
31 namespace OrthancDatabases |
| 202 | 32 { |
| 33 class IDatabaseBackend : public boost::noncopyable | |
| 34 { | |
| 35 public: | |
| 36 virtual ~IDatabaseBackend() | |
| 37 { | |
| 38 } | |
| 39 | |
| 40 virtual OrthancPluginContext* GetContext() = 0; | |
| 41 | |
|
255
d663d9e44f8d
reintroduction of IDatabaseFactory into DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
42 virtual IDatabaseFactory* CreateDatabaseFactory() = 0; |
|
226
a4918d57435c
DatabaseManager doesn't IDatabaseFactory anymore
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
43 |
|
a4918d57435c
DatabaseManager doesn't IDatabaseFactory anymore
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
44 // This function is invoked once, even if multiple connections are open |
|
237
35598014f140
refactoring to remove GlobalProperties.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
226
diff
changeset
|
45 virtual void ConfigureDatabase(DatabaseManager& database) = 0; |
|
224
61c309e06797
added internal class DatabaseBackendAdapterV2::Adapter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
46 |
| 202 | 47 virtual void SetOutputFactory(IDatabaseBackendOutput::IFactory* factory) = 0; |
| 48 | |
| 49 virtual IDatabaseBackendOutput* CreateOutput() = 0; | |
| 50 | |
|
260
793bbbe11287
IDatabaseBackend::HasRevisionsSupport()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
256
diff
changeset
|
51 virtual bool HasRevisionsSupport() const = 0; |
|
793bbbe11287
IDatabaseBackend::HasRevisionsSupport()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
256
diff
changeset
|
52 |
|
366
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
53 virtual bool HasAttachmentCustomDataSupport() const = 0; |
|
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
54 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
55 virtual void AddAttachment(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
56 int64_t id, |
|
261
34e2b93a7ac1
implementing interface for revisions in attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
260
diff
changeset
|
57 const OrthancPluginAttachment& attachment, |
|
34e2b93a7ac1
implementing interface for revisions in attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
260
diff
changeset
|
58 int64_t revision) = 0; |
| 202 | 59 |
|
366
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
60 #if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 12, 0) |
|
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
61 |
|
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
62 virtual void AddAttachment2(DatabaseManager& manager, |
|
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
63 int64_t id, |
|
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
64 const OrthancPluginAttachment2& attachment, |
|
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
65 int64_t revision) = 0; |
|
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
66 #endif |
|
cd9521e04249
DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents:
261
diff
changeset
|
67 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
68 virtual void AttachChild(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
69 int64_t parent, |
| 202 | 70 int64_t child) = 0; |
| 71 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
72 virtual void ClearChanges(DatabaseManager& manager) = 0; |
| 202 | 73 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
74 virtual void ClearExportedResources(DatabaseManager& manager) = 0; |
| 202 | 75 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
76 virtual int64_t CreateResource(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
77 const char* publicId, |
| 202 | 78 OrthancPluginResourceType type) = 0; |
| 79 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
80 virtual void DeleteAttachment(IDatabaseBackendOutput& output, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
81 DatabaseManager& manager, |
| 202 | 82 int64_t id, |
| 83 int32_t attachment) = 0; | |
| 84 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
85 virtual void DeleteMetadata(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
86 int64_t id, |
| 202 | 87 int32_t metadataType) = 0; |
| 88 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
89 virtual void DeleteResource(IDatabaseBackendOutput& output, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
90 DatabaseManager& manager, |
| 202 | 91 int64_t id) = 0; |
| 92 | |
| 93 virtual void GetAllInternalIds(std::list<int64_t>& target, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
94 DatabaseManager& manager, |
| 202 | 95 OrthancPluginResourceType resourceType) = 0; |
| 96 | |
| 97 virtual void GetAllPublicIds(std::list<std::string>& target, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
98 DatabaseManager& manager, |
| 202 | 99 OrthancPluginResourceType resourceType) = 0; |
| 100 | |
| 101 virtual void GetAllPublicIds(std::list<std::string>& target, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
102 DatabaseManager& manager, |
| 202 | 103 OrthancPluginResourceType resourceType, |
| 104 uint64_t since, | |
| 105 uint64_t limit) = 0; | |
| 106 | |
| 107 /* Use GetOutput().AnswerChange() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
108 virtual void GetChanges(IDatabaseBackendOutput& output, |
| 202 | 109 bool& done /*out*/, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
110 DatabaseManager& manager, |
| 202 | 111 int64_t since, |
| 112 uint32_t maxResults) = 0; | |
| 113 | |
| 114 virtual void GetChildrenInternalId(std::list<int64_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
115 DatabaseManager& manager, |
| 202 | 116 int64_t id) = 0; |
| 117 | |
| 118 virtual void GetChildrenPublicId(std::list<std::string>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
119 DatabaseManager& manager, |
| 202 | 120 int64_t id) = 0; |
| 121 | |
| 122 /* Use GetOutput().AnswerExportedResource() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
123 virtual void GetExportedResources(IDatabaseBackendOutput& output, |
| 202 | 124 bool& done /*out*/, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
125 DatabaseManager& manager, |
| 202 | 126 int64_t since, |
| 127 uint32_t maxResults) = 0; | |
| 128 | |
| 129 /* Use GetOutput().AnswerChange() */ | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
130 virtual void GetLastChange(IDatabaseBackendOutput& output, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
131 DatabaseManager& manager) = 0; |
| 202 | 132 |
| 133 /* Use GetOutput().AnswerExportedResource() */ | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
134 virtual void GetLastExportedResource(IDatabaseBackendOutput& output, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
135 DatabaseManager& manager) = 0; |
| 202 | 136 |
| 137 /* Use GetOutput().AnswerDicomTag() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
138 virtual void GetMainDicomTags(IDatabaseBackendOutput& output, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
139 DatabaseManager& manager, |
| 202 | 140 int64_t id) = 0; |
| 141 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
142 virtual std::string GetPublicId(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
143 int64_t resourceId) = 0; |
| 202 | 144 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
145 virtual uint64_t GetResourcesCount(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
146 OrthancPluginResourceType resourceType) = 0; |
| 202 | 147 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
148 virtual OrthancPluginResourceType GetResourceType(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
149 int64_t resourceId) = 0; |
| 202 | 150 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
151 virtual uint64_t GetTotalCompressedSize(DatabaseManager& manager) = 0; |
| 202 | 152 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
153 virtual uint64_t GetTotalUncompressedSize(DatabaseManager& manager) = 0; |
| 202 | 154 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
155 virtual bool IsExistingResource(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
156 int64_t internalId) = 0; |
| 202 | 157 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
158 virtual bool IsProtectedPatient(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
159 int64_t internalId) = 0; |
| 202 | 160 |
| 161 virtual void ListAvailableMetadata(std::list<int32_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
162 DatabaseManager& manager, |
| 202 | 163 int64_t id) = 0; |
| 164 | |
| 165 virtual void ListAvailableAttachments(std::list<int32_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
166 DatabaseManager& manager, |
| 202 | 167 int64_t id) = 0; |
| 168 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
169 virtual void LogChange(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
170 int32_t changeType, |
| 209 | 171 int64_t resourceId, |
| 172 OrthancPluginResourceType resourceType, | |
| 173 const char* date) = 0; | |
| 174 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
175 virtual void LogExportedResource(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
176 const OrthancPluginExportedResource& resource) = 0; |
| 202 | 177 |
| 178 /* Use GetOutput().AnswerAttachment() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
179 virtual bool LookupAttachment(IDatabaseBackendOutput& output, |
|
261
34e2b93a7ac1
implementing interface for revisions in attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
260
diff
changeset
|
180 int64_t& revision /*out*/, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
181 DatabaseManager& manager, |
| 202 | 182 int64_t id, |
| 183 int32_t contentType) = 0; | |
| 184 | |
| 185 virtual bool LookupGlobalProperty(std::string& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
186 DatabaseManager& manager, |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
187 const char* serverIdentifier, |
| 202 | 188 int32_t property) = 0; |
| 189 | |
| 190 virtual void LookupIdentifier(std::list<int64_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
191 DatabaseManager& manager, |
| 202 | 192 OrthancPluginResourceType resourceType, |
| 193 uint16_t group, | |
| 194 uint16_t element, | |
| 195 OrthancPluginIdentifierConstraint constraint, | |
| 196 const char* value) = 0; | |
| 197 | |
| 198 virtual void LookupIdentifierRange(std::list<int64_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
199 DatabaseManager& manager, |
| 202 | 200 OrthancPluginResourceType resourceType, |
| 201 uint16_t group, | |
| 202 uint16_t element, | |
| 203 const char* start, | |
| 204 const char* end) = 0; | |
| 205 | |
| 206 virtual bool LookupMetadata(std::string& target /*out*/, | |
|
256
e184dcadf163
handling of revisions in metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
255
diff
changeset
|
207 int64_t& revision /*out*/, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
208 DatabaseManager& manager, |
| 202 | 209 int64_t id, |
| 210 int32_t metadataType) = 0; | |
| 211 | |
| 212 virtual bool LookupParent(int64_t& parentId /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
213 DatabaseManager& manager, |
| 202 | 214 int64_t resourceId) = 0; |
| 215 | |
| 216 virtual bool LookupResource(int64_t& id /*out*/, | |
| 217 OrthancPluginResourceType& type /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
218 DatabaseManager& manager, |
| 202 | 219 const char* publicId) = 0; |
| 220 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
221 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
222 DatabaseManager& manager) = 0; |
| 202 | 223 |
| 224 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
225 DatabaseManager& manager, |
| 202 | 226 int64_t patientIdToAvoid) = 0; |
| 227 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
228 virtual void SetGlobalProperty(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
229 const char* serverIdentifier, |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
230 int32_t property, |
|
237
35598014f140
refactoring to remove GlobalProperties.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
226
diff
changeset
|
231 const char* utf8) = 0; |
| 202 | 232 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
233 virtual void SetMainDicomTag(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
234 int64_t id, |
| 202 | 235 uint16_t group, |
| 236 uint16_t element, | |
| 237 const char* value) = 0; | |
| 238 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
239 virtual void SetIdentifierTag(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
240 int64_t id, |
| 202 | 241 uint16_t group, |
| 242 uint16_t element, | |
| 243 const char* value) = 0; | |
| 244 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
245 virtual void SetMetadata(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
246 int64_t id, |
| 202 | 247 int32_t metadataType, |
|
256
e184dcadf163
handling of revisions in metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
255
diff
changeset
|
248 const char* value, |
|
e184dcadf163
handling of revisions in metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
255
diff
changeset
|
249 int64_t revision) = 0; |
| 202 | 250 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
251 virtual void SetProtectedPatient(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
252 int64_t internalId, |
| 202 | 253 bool isProtected) = 0; |
| 254 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
255 virtual uint32_t GetDatabaseVersion(DatabaseManager& manager) = 0; |
| 202 | 256 |
| 257 /** | |
| 258 * Upgrade the database to the specified version of the database | |
| 259 * schema. The upgrade script is allowed to make calls to | |
| 260 * OrthancPluginReconstructMainDicomTags(). | |
| 261 **/ | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
262 virtual void UpgradeDatabase(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
263 uint32_t targetVersion, |
| 202 | 264 OrthancPluginStorageArea* storageArea) = 0; |
| 265 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
266 virtual void ClearMainDicomTags(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
267 int64_t internalId) = 0; |
| 202 | 268 |
| 269 virtual bool HasCreateInstance() const = 0; | |
| 270 | |
| 271 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
272 virtual void LookupResources(IDatabaseBackendOutput& output, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
273 DatabaseManager& manager, |
| 202 | 274 const std::vector<Orthanc::DatabaseConstraint>& lookup, |
| 275 OrthancPluginResourceType queryLevel, | |
| 276 uint32_t limit, | |
| 277 bool requestSomeInstance) = 0; | |
| 278 #endif | |
| 279 | |
| 280 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
| 281 virtual void CreateInstance(OrthancPluginCreateInstanceResult& result, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
282 DatabaseManager& manager, |
| 202 | 283 const char* hashPatient, |
| 284 const char* hashStudy, | |
| 285 const char* hashSeries, | |
| 286 const char* hashInstance) = 0; | |
| 287 #endif | |
| 288 | |
| 289 | |
| 290 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
| 291 virtual void SetResourcesContent( | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
292 DatabaseManager& manager, |
| 202 | 293 uint32_t countIdentifierTags, |
| 294 const OrthancPluginResourcesContentTags* identifierTags, | |
| 295 uint32_t countMainDicomTags, | |
| 296 const OrthancPluginResourcesContentTags* mainDicomTags, | |
| 297 uint32_t countMetadata, | |
| 298 const OrthancPluginResourcesContentMetadata* metadata) = 0; | |
| 299 #endif | |
| 300 | |
| 301 | |
| 302 virtual void GetChildrenMetadata(std::list<std::string>& target, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
303 DatabaseManager& manager, |
| 202 | 304 int64_t resourceId, |
| 305 int32_t metadata) = 0; | |
| 306 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
307 virtual int64_t GetLastChangeIndex(DatabaseManager& manager) = 0; |
| 202 | 308 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
309 virtual void TagMostRecentPatient(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
310 int64_t patientId) = 0; |
| 202 | 311 |
| 312 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1 | |
| 313 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
| 314 // NB: "parentPublicId" must be cleared if the resource has no parent | |
| 315 virtual bool LookupResourceAndParent(int64_t& id, | |
| 316 OrthancPluginResourceType& type, | |
| 317 std::string& parentPublicId, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
318 DatabaseManager& manager, |
| 202 | 319 const char* publicId) = 0; |
| 320 # endif | |
| 321 #endif | |
| 322 | |
| 323 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1 | |
| 324 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
| 325 virtual void GetAllMetadata(std::map<int32_t, std::string>& result, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
326 DatabaseManager& manager, |
| 202 | 327 int64_t id) = 0; |
| 328 # endif | |
| 329 #endif | |
| 330 }; | |
| 331 } |