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
  21  module com {  module sun {  module star {  module embed {
  22
  23 /** This is a service that allows to get access to a file system folder using
  24     storage hierarchy.
  25  */
  26 published service FileSystemStorage
  27 {
  28     /** This service describes the base functionality of storages.
  29
  30         <p>
  31         Please see below the description of additional requirements for the
  32         file system storage implementation.
  33         </p>
  34
  35         <dl>
  36             <dt>interface com::sun::star::lang::XComponent
  37             </dt>
  38             <dd>
  39                 <p>
  40                 A file system storage is created either by
  41                 StorageFactory or by XStorage
  42                 interface and is controlled by refcounting. In case
  43                 refcounting is decreased to zero the storage will be
  44                 disposed automatically.
  45                 </p>
  46
  47                 <p>
  48                 In case a storage object is disposed the elements
  49                 ( substorages and substreams ) are not affected.
  50                 </p>
  51             </dd>
  52             <dt>interface XStorage</dt>
  53             <dd>
  54                 <dl>
  55                     <dt>XStorage::openStorageElement()</dt>
  56                     <dd>
  57                         This method returns FileSystemStorage
  58                         service implementation.
  59                     </dd>
  60
  61                     <dt>XStorage::copyLastCommitTo()</dt>
  62                     <dd>
  63                         Since this service implementation supports no transaction
  64                         this method just creates a copy of the storage in its
  65                         current state.
  66                     </dd>
  67
  68                     <dt>XStorage::copyStorageElementLastCommitTo()</dt>
  69                     <dd>
  70                         Since this service implementation supports no transaction
  71                         this method just creates a copy of the storage in its
  72                         current state.
  73                     </dd>
  74
  75                     <dt>XStorage::removeStorageElement()</dt>
  76                     <dd>
  77                         If the element is opened and it is a stream element
  78                         the removing will fail. If the element is opened and
  79                         it is a storage element, all the contents that can be
  80                         removed will be removed.
  81                     </dd>
  82                 </dl>
  83             </dd>
  84             <dt>property URL</dt>
  85             <dd>
  86                 This property is not optional for this service.
  87             </dd>
  88         </dl>
  89
  90      */
  91     service BaseStorage;
  92 };
  93
  94
  95 }; }; }; };
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */