xref: /trunk/main/autodoc/inc/ary/loc/locp_le.hxx (revision 1c78a5d6)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ARY_LOCP_LE_HXX
25 #define ARY_LOCP_LE_HXX
26 
27 
28 // USED SERVICES
29 	// BASE CLASSES
30 	// COMPONENTS
31 	// PARAMETERS
32 #include <cosv/ploc.hxx>
33 #include <ary/loc/loc_types4loc.hxx>
34 
35 
36 namespace ary
37 {
38 namespace loc
39 {
40     class Root;
41     class Directory;
42     class File;
43 }
44 }
45 
46 
47 namespace ary
48 {
49 namespace loc
50 {
51 
52 
53 
54 /** Provides access to files and directories stored in the
55     repository.
56 */
57 class LocationPilot
58 {
59   public:
~LocationPilot()60     virtual             ~LocationPilot() {}
61 
62     virtual Root &      CheckIn_Root(
63                             const csv::ploc::Path &
64                                                 i_rPath ) = 0;
65     virtual File &      CheckIn_File(
66                             const String  &     i_name,
67                             const csv::ploc::DirectoryChain &
68                                                 i_subPath,
69                             Le_id               i_root ) = 0;
70 
71     virtual Root &      Find_Root(
72                             Le_id               i_id ) const = 0;
73     virtual Directory & Find_Directory(
74                             Le_id               i_id ) const = 0;
75     virtual File &      Find_File(
76                             Le_id               i_id ) const = 0;
77 };
78 
79 
80 
81 
82 }   // namespace loc
83 }   // namespace ary
84 #endif
85