offapi/com/sun/star/embed/FileSystemStorage.idl

   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: FileSystemStorage.idl,v $
  10  * $Revision: 1.4 $
  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 __com_sun_star_embed_FileSystemStorage_idl__
  32 #define __com_sun_star_embed_FileSystemStorage_idl__
  33
  34 #ifndef __com_sun_star_embed_BaseStorage_idl__
  35 #include <com/sun/star/embed/BaseStorage.idl>
  36 #endif
  37
  38 //============================================================================
  39
  40  module com {  module sun {  module star {  module embed {
  41
  42 //============================================================================
  43 /** This is a service that allows to get access to a file system folder using
  44     storage hierarchy.
  45  */
  46 service FileSystemStorage
  47 {
  48     // -----------------------------------------------------------------------
  49     /** This service describes the base functionality of storages.
  50
  51         <p>
  52         Please see below the description of additional requirements for the
  53         file system storage implementation.
  54         </p>
  55
  56         <dl>
  57             <dt>interface <type scope="com::sun::star::lang">XComponent</type>
  58             </dt>
  59             <dd>
  60                 <p>
  61                 A file system storage is created either by
  62                 <type>StorageFactory</type> or by <type>XStorage</type>
  63                 interface and is controlled by refcounting. In case
  64                 refcounting is decreased to zero the storage will be
  65                 disposed automatically.
  66                 </p>
  67
  68                 <p>
  69                 In case a storage object is disposed the elements
  70                 ( substorages and substreams ) are not affected.
  71                 </p>
  72             </dd>
  73             <dt>interface <type>XStorage</type></dt>
  74             <dd>
  75                 <dl>
  76                     <dt><method>XStorage::openStorageElement</method></dt>
  77                     <dd>
  78                         This method returns <type>FileSystemStorage</type>
  79                         service implementation.
  80                     </dd>
  81
  82                     <dt><method>XStorage::copyLastCommitTo</method></dt>
  83                     <dd>
  84                         Since this service implementation supports no transaction
  85                         this method just creates a copy of the storage in it's
  86                         current state.
  87                     </dd>
  88
  89                     <dt><method>XStorage::copyStorageElementLastCommitTo</method></dt>
  90                     <dd>
  91                         Since this service implementation supports no transaction
  92                         this method just creates a copy of the storage in it's
  93                         current state.
  94                     </dd>
  95
  96                     <dt><method>XStorage::removeStorageElement</method></dt>
  97                     <dd>
  98                         If the element is opened and it is a stream element
  99                         the removing will fail. If the element is opened and
 100                         it is a storage element, all the contents that can be
 101                         removed will be removed.
 102                     </dd>
 103                 </dl>
 104             </dd>
 105             <dt>property URL</dt>
 106             <dd>
 107                 This property is not optional for this service.
 108             </dd>
 109         </dl>
 110
 111      */
 112     service BaseStorage;
 113 };
 114
 115 //============================================================================
 116
 117 }; }; }; };
 118
 119 #endif
 120