0024157: Parallelization of assembly part of BO
[occt.git] / src / CDM / CDM_Application.cdl
1 -- Created on: 1997-10-22
2 -- Created by: Jean-Louis Frenkel
3 -- Copyright (c) 1997-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21 ---Copy:         Matra Datavision 1997
22
23 deferred class Application from CDM inherits Transient from Standard
24
25 uses Document           from CDM,
26      MetaData           from CDM,
27      Reference          from CDM,
28      MessageDriver      from CDM,
29      Manager            from Resource,
30      ExtendedString     from TCollection
31 is
32
33     Retrieve(me: mutable; aMetaData: MetaData from CDM; UseStorageConfiguration: Boolean from Standard)
34     returns mutable Document from CDM
35     is deferred private;
36
37
38     DocumentVersion(me: mutable; aMetaData: MetaData from CDM)
39     returns Integer from Standard
40     is deferred private;
41     ---Purpose: returns -1 if the metadata has no modification counter.
42     
43     SetDocumentVersion(me; aDocument: Document from CDM; aMetaData: MetaData from CDM)
44     is protected;
45
46     SetReferenceCounter(me:mutable ; aDocument: Document from CDM; aReferenceCounter: Integer from Standard)
47     is protected;
48     
49     Resources(me: mutable)
50     returns Manager from Resource
51     is deferred;
52     ---Purpose: the manager returned by  this virtual  method will be
53     --          used to search for Format`.Retrieval  resource items. 
54     --          
55     
56     MessageDriver(me: mutable) returns MessageDriver from CDM
57     is virtual;
58     ---Purpose: By default returns a NullMessageDriver;
59
60     BeginOfUpdate(me:mutable; aDocument: Document from CDM)
61     is virtual;
62     ---Purpose: this method is called before the update of a document.
63     --         By default, writes in MessageDriver().
64
65     EndOfUpdate(me:mutable; aDocument: Document from CDM; Status: Boolean from Standard; ErrorString: ExtendedString from TCollection)
66     is virtual;
67     ---Purpose: this method is called affter the update of a document.
68     --         By default, writes in MessageDriver().
69
70     Write(me: mutable; aString: ExtString from Standard);
71     ---Purpose: writes the string in the application MessagerDriver.
72
73 friends     
74
75     class Reference from CDM,
76     class MetaData from CDM
77
78 end Application from CDM;