0025812: Replace dynamic loading mechanism of OCAF persistence with dynamic-link one
[occt.git] / src / CDM / CDM_Application.hxx
1 // Created on: 1997-10-22
2 // Created by: Jean-Louis Frenkel
3 // Copyright (c) 1997-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _CDM_Application_HeaderFile
18 #define _CDM_Application_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Transient.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_ExtString.hxx>
27 class CDM_Reference;
28 class CDM_MetaData;
29 class CDM_Document;
30 class Resource_Manager;
31 class CDM_MessageDriver;
32 class TCollection_ExtendedString;
33
34
35 class CDM_Application;
36 DEFINE_STANDARD_HANDLE(CDM_Application, Standard_Transient)
37
38
39 class CDM_Application : public Standard_Transient
40 {
41
42 public:
43
44   
45   //! The manager returned by  this virtual  method will be
46   //! used to search for Format.Retrieval  resource items.
47   Standard_EXPORT virtual Handle(Resource_Manager) Resources() = 0;
48   
49   //! By default returns a NullMessageDriver;
50   Standard_EXPORT virtual Handle(CDM_MessageDriver) MessageDriver();
51   
52   //! this method is called before the update of a document.
53   //! By default, writes in MessageDriver().
54   Standard_EXPORT virtual void BeginOfUpdate (const Handle(CDM_Document)& aDocument);
55   
56   //! this method is called affter the update of a document.
57   //! By default, writes in MessageDriver().
58   Standard_EXPORT virtual void EndOfUpdate (const Handle(CDM_Document)& aDocument, const Standard_Boolean Status, const TCollection_ExtendedString& ErrorString);
59   
60   //! writes the string in the application MessagerDriver.
61   Standard_EXPORT void Write (const Standard_ExtString aString);
62
63
64 friend class CDM_Reference;
65 friend class CDM_MetaData;
66
67
68   DEFINE_STANDARD_RTTIEXT(CDM_Application,Standard_Transient)
69
70 protected:
71
72   
73   Standard_EXPORT void SetDocumentVersion (const Handle(CDM_Document)& aDocument, const Handle(CDM_MetaData)& aMetaData) const;
74   
75   Standard_EXPORT void SetReferenceCounter (const Handle(CDM_Document)& aDocument, const Standard_Integer aReferenceCounter);
76
77
78
79 private:
80
81   
82   Standard_EXPORT virtual Handle(CDM_Document) Retrieve (const Handle(CDM_MetaData)& aMetaData, const Standard_Boolean UseStorageConfiguration) = 0;
83   
84   //! returns -1 if the metadata has no modification counter.
85   Standard_EXPORT virtual Standard_Integer DocumentVersion (const Handle(CDM_MetaData)& aMetaData) = 0;
86
87
88
89 };
90
91
92
93
94
95
96
97 #endif // _CDM_Application_HeaderFile