autodoc/inc/ary/loc/locp_le.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: locp_le.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_LOCP_LE_HXX
  32 #define ARY_LOCP_LE_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37     // COMPONENTS
  38     // PARAMETERS
  39 #include <cosv/ploc.hxx>
  40 #include <ary/loc/loc_types4loc.hxx>
  41
  42
  43 namespace ary
  44 {
  45 namespace loc
  46 {
  47     class Root;
  48     class Directory;
  49     class File;
  50 }
  51 }
  52
  53
  54 namespace ary
  55 {
  56 namespace loc
  57 {
  58
  59
  60
  61 /** Provides access to files and directories stored in the
  62     repository.
  63 */
  64 class LocationPilot
  65 {
  66   public:
  67     virtual             ~LocationPilot() {}
  68
  69     virtual Root &      CheckIn_Root(
  70                             const csv::ploc::Path &
  71                                                 i_rPath ) = 0;
  72     virtual File &      CheckIn_File(
  73                             const String  &     i_name,
  74                             const csv::ploc::DirectoryChain &
  75                                                 i_subPath,
  76                             Le_id               i_root ) = 0;
  77
  78     virtual Root &      Find_Root(
  79                             Le_id               i_id ) const = 0;
  80     virtual Directory & Find_Directory(
  81                             Le_id               i_id ) const = 0;
  82     virtual File &      Find_File(
  83                             Le_id               i_id ) const = 0;
  84 };
  85
  86
  87
  88
  89 }   // namespace loc
  90 }   // namespace ary
  91 #endif