1 /*
2 * Copyright (c) 2024 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 META_INTERFACE_SERIALIZATION_ISERIALIZABLE_H
17 #define META_INTERFACE_SERIALIZATION_ISERIALIZABLE_H
18
19 #include <core/plugin/intf_interface.h>
20
21 #include <meta/base/interface_macros.h>
22 #include <meta/base/namespace.h>
23 #include <meta/interface/serialization/intf_export_context.h>
24 #include <meta/interface/serialization/intf_import_context.h>
25
META_BEGIN_NAMESPACE()26 META_BEGIN_NAMESPACE()
27
28 /// Explicit serialisation interface for objects
29 class ISerializable : public CORE_NS::IInterface {
30 META_INTERFACE(CORE_NS::IInterface, ISerializable, "b832ef10-9cb2-4222-8429-eef0e1bbed3b")
31 public:
32 /// Called when object is being exported
33 virtual ReturnError Export(IExportContext&) const = 0;
34 /// Called when object is being imported
35 virtual ReturnError Import(IImportContext&) = 0;
36 };
37
38 /// Interface for objects to support finalize call after the whole object hierarchy has been imported
39 class IImportFinalize : public CORE_NS::IInterface {
40 META_INTERFACE(CORE_NS::IInterface, IImportFinalize, "b01e26e5-5b83-45fa-94c4-b461425b2311")
41 public:
42 /**
43 * @brief Called after whole object interface has been imported
44 * @return Return error to fail the import process, or success to continue
45 *
46 * This can be used to check the data is valid or use IImportFunctions to resolve ref uri.
47 * The Finalize calls are called the opposite order than importing, it is called last for the root node.
48 */
49 virtual ReturnError Finalize(IImportFunctions&) = 0;
50 };
51
52 META_INTERFACE_TYPE(META_NS::ISerializable)
53
54 META_END_NAMESPACE()
55
56 #endif
57