0024925: Enabling OCAF persistence without setting environment variables
[occt.git] / src / CDF / CDF.cdl
1 -- Created on: 1997-08-07
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 package CDF
18
19
20 uses CDM, PCDM, TCollection, TColStd, Storage, Resource, Quantity, OSD
21
22 is
23     class Directory;
24     class DirectoryIterator;
25     
26     class Session;
27     
28     enumeration TypeOfActivation is TOA_New,TOA_Modified,TOA_Unchanged
29     end TypeOfActivation from CDF;
30     
31     deferred class Application;
32
33     private class StoreList;
34
35 ---Category: API for Store and retrieve
36 --           
37     
38     class Store;
39
40     
41     enumeration TryStoreStatus is TS_OK,TS_NoCurrentDocument,TS_NoDriver,TS_NoSubComponentDriver
42     end TryStoreStatus;
43
44     enumeration SubComponentStatus is SCS_Consistent, SCS_Unconsistent,SCS_Stored,SCS_Modified
45     end SubComponentStatus;
46     
47     enumeration StoreSetNameStatus  is  
48     SSNS_OK, 
49     SSNS_ReplacingAnExistentDocument, 
50     SSNS_OpenDocument
51     end StoreSetNameStatus;
52     
53     
54     ---Category: MetaData management
55     --           
56
57     deferred class MetaDataDriver;
58
59     class FWOSDriver;
60
61
62     exception MetaDataDriverError inherits Failure from Standard;
63     ---Purpose: this exception is used in the deferred methods.
64     --          Programmer implementing such methods may use this
65     --          exception or any exception inheriting MetaDataDriverError.
66
67
68     deferred class MetaDataDriverFactory;
69
70
71     private class Timer;
72     
73     GetLicense(anApplicationIdentifier: Integer from Standard);
74     
75     IsAvailable(anApplicationIdentifier: Integer from Standard)
76     returns Boolean from Standard;
77
78 end CDF;