offapi/com/sun/star/embed/FileSystemStorageFactory.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: FileSystemStorageFactory.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_FileSystemStorageFactory_idl__
  32 #define __com_sun_star_embed_FileSystemStorageFactory_idl__
  33
  34 #ifndef __com_sun_star_lang_XSingleServiceFactory_idl__
  35 #include <com/sun/star/lang/XSingleServiceFactory.idl>
  36 #endif
  37
  38
  39 //============================================================================
  40
  41  module com {  module sun {  module star {  module embed {
  42
  43 //============================================================================
  44 /** The <type>FileSystemStorageFactory</type> is a service that allows to
  45     create a <type>FileSystemStorage</type> based on URL. The URL must point
  46     to a folder.
  47  */
  48 service FileSystemStorageFactory
  49 {
  50     // ----------------------------------------------------------------------
  51     /** A storage can be created through this interface.
  52
  53         <p>
  54         In case
  55         <method scope="com::sun::star::lang">XSingleServiceFactory::createInstance</method>
  56         call is used the result storage will be open in readwrite mode based
  57         on an arbitrary file system folder.
  58         </p>
  59
  60         <p>
  61         In case
  62         <method scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</method>
  63         call is used a sequence of the following parameters can be used:
  64         </p>
  65
  66         <dl>
  67             <dt>parameter 1</dt>
  68             <dd>
  69                       specifies source of the object, it must be a string
  70                       containing URL.
  71             </dd>
  72
  73             <dt>parameter 2</dt>
  74             <dd>
  75                       specifies mode the storage should be open in, can take
  76                       values from <type>ElementModes</type> constant set.
  77             </dd>
  78
  79             <dt>parameter 3</dt>
  80             <dd>
  81                       allowes to provide
  82                       <type scope="com::sun::star::document">MediaDescryptor</type>
  83                       to the storage so some parts can be used for
  84                       initialization, it can be for example
  85                       <type scope="com::sun::star::task">XInteractionHandler</type>
  86                       implementation.
  87             </dd>
  88         </dl>
  89
  90         <p>
  91         The parameters are optional, that means that sequence can be empty or
  92         contain only first parameter, or first and second one. In case
  93         no parameters are provided the call works the same way as
  94         <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>.
  95         In case only first parameter is provided, the storage is opened in
  96         readonly mode.
  97         </p>
  98
  99         <p>
 100         The opened storages can support read access in addition to
 101         specified one.
 102         </p>
 103      */
 104     interface ::com::sun::star::lang::XSingleServiceFactory;
 105 };
 106
 107 //============================================================================
 108
 109 }; }; }; };
 110
 111 #endif
 112