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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_embed_FileSystemStorage_idl__
  21 #define __com_sun_star_embed_FileSystemStorage_idl__
  22
  23 #include <com/sun/star/embed/BaseStorage.idl>
  24
  25
  26  module com {  module sun {  module star {  module embed {
  27
  28 /** This is a service that allows to get access to a file system folder using
  29     storage hierarchy.
  30  */
  31 published service FileSystemStorage
  32 {
  33     /** This service describes the base functionality of storages.
  34
  35         <p>
  36         Please see below the description of additional requirements for the
  37         file system storage implementation.
  38         </p>
  39
  40         <dl>
  41             <dt>interface com::sun::star::lang::XComponent
  42             </dt>
  43             <dd>
  44                 <p>
  45                 A file system storage is created either by
  46                 StorageFactory or by XStorage
  47                 interface and is controlled by refcounting. In case
  48                 refcounting is decreased to zero the storage will be
  49                 disposed automatically.
  50                 </p>
  51
  52                 <p>
  53                 In case a storage object is disposed the elements
  54                 ( substorages and substreams ) are not affected.
  55                 </p>
  56             </dd>
  57             <dt>interface XStorage</dt>
  58             <dd>
  59                 <dl>
  60                     <dt>XStorage::openStorageElement()</dt>
  61                     <dd>
  62                         This method returns FileSystemStorage
  63                         service implementation.
  64                     </dd>
  65
  66                     <dt>XStorage::copyLastCommitTo()</dt>
  67                     <dd>
  68                         Since this service implementation supports no transaction
  69                         this method just creates a copy of the storage in its
  70                         current state.
  71                     </dd>
  72
  73                     <dt>XStorage::copyStorageElementLastCommitTo()</dt>
  74                     <dd>
  75                         Since this service implementation supports no transaction
  76                         this method just creates a copy of the storage in its
  77                         current state.
  78                     </dd>
  79
  80                     <dt>XStorage::removeStorageElement()</dt>
  81                     <dd>
  82                         If the element is opened and it is a stream element
  83                         the removing will fail. If the element is opened and
  84                         it is a storage element, all the contents that can be
  85                         removed will be removed.
  86                     </dd>
  87                 </dl>
  88             </dd>
  89             <dt>property URL</dt>
  90             <dd>
  91                 This property is not optional for this service.
  92             </dd>
  93         </dl>
  94
  95      */
  96     service BaseStorage;
  97 };
  98
  99
 100 }; }; }; };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */