offapi/com/sun/star/embed/StorageFactory.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: StorageFactory.idl,v $
  10  * $Revision: 1.5 $
  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_StorageFactory_idl__
  32 #define __com_sun_star_embed_StorageFactory_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>StorageFactory</type> is a service that allows to create
  45     a storage based on either stream or URL.
  46  */
  47 service StorageFactory
  48 {
  49     // ----------------------------------------------------------------------
  50     /** A storage can be created through this interface.
  51
  52         <p>
  53         In case
  54         <method scope="com::sun::star::lang">XSingleServiceFactory::createInstance</method>
  55         call is used the result storage will be open in readwrite mode based
  56         on an arbitrary medium.
  57         </p>
  58
  59         <p>
  60         In case
  61         <method scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</method>
  62         call is used a sequence of the following parameters can be used:
  63         </p>
  64
  65         <dl>
  66             <dt>parameter 1</dt>
  67             <dd>
  68                       specifies source of the object, it can be a string
  69                       containing URL, an
  70                       <type scope="com::sun::star::io">XStream</type>
  71                       implementation or
  72                       <type scope="com::sun::star::io">XInputStream</type>;
  73                       in case of
  74                       <type scope="com::sun::star::io">XStream</type>
  75                       implementation
  76                       the <type scope="com::sun::star::io">XSeekable</type>
  77                       interface must be supported.
  78             </dd>
  79
  80             <dt>parameter 2</dt>
  81             <dd>
  82                       specifies mode the storage should be open in, can take
  83                       values from <type>ElementModes</type> constant set.
  84             </dd>
  85
  86             <dt>parameter 3</dt>
  87             <dd>
  88                       allowes to provide
  89                       <type scope="com::sun::star::document">MediaDescryptor</type>
  90                       to the storage so some parts can be used for
  91                       initialization, it can be for example
  92                       <type scope="com::sun::star::task">XInteractionHandler</type>
  93                       implementation, password for the storage and repair
  94                       package flag.
  95             </dd>
  96         </dl>
  97
  98         <p>
  99         The parameters are optional, that means that sequence can be empty or
 100         contain only first parameter, or first and second one. In case
 101         no parameters are provided the call works the same way as
 102         <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>.
 103         In case only first parameter is provided, the storage is opened in
 104         readonly mode.
 105         </p>
 106
 107         <p>
 108         The opened root storage can support read access in addition to
 109         specified one.
 110         </p>
 111      */
 112     interface ::com::sun::star::lang::XSingleServiceFactory;
 113 };
 114
 115 //============================================================================
 116
 117 }; }; }; };
 118
 119 #endif
 120