1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_embed_FileSystemStorageFactory_idl__
25#define __com_sun_star_embed_FileSystemStorageFactory_idl__
26
27#ifndef __com_sun_star_lang_XSingleServiceFactory_idl__
28#include <com/sun/star/lang/XSingleServiceFactory.idl>
29#endif
30
31
32//============================================================================
33
34 module com {  module sun {  module star {  module embed {
35
36//============================================================================
37/** The <type>FileSystemStorageFactory</type> is a service that allows to
38	create a <type>FileSystemStorage</type> based on URL. The URL must point
39	to a folder.
40 */
41published service FileSystemStorageFactory
42{
43	// ----------------------------------------------------------------------
44	/** A storage can be created through this interface.
45
46		<p>
47		In case
48		<method scope="com::sun::star::lang">XSingleServiceFactory::createInstance</method>
49		call is used the result storage will be open in readwrite mode based
50		on an arbitrary file system folder.
51		</p>
52
53		<p>
54		In case
55		<method scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</method>
56		call is used a sequence of the following parameters can be used:
57		</p>
58
59		<dl>
60			<dt>parameter 1</dt>
61			<dd>
62					  specifies source of the object, it must be a string
63					  containing URL.
64			</dd>
65
66			<dt>parameter 2</dt>
67			<dd>
68					  specifies mode the storage should be open in, can take
69					  values from <type>ElementModes</type> constant set.
70			</dd>
71
72			<dt>parameter 3</dt>
73			<dd>
74					  allowes to provide
75					  <type scope="com::sun::star::document">MediaDescryptor</type>
76					  to the storage so some parts can be used for
77					  initialization, it can be for example
78					  <type scope="com::sun::star::task">XInteractionHandler</type>
79					  implementation.
80			</dd>
81		</dl>
82
83		<p>
84		The parameters are optional, that means that sequence can be empty or
85		contain only first parameter, or first and second one. In case
86		no parameters are provided the call works the same way as
87		<member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>.
88		In case only first parameter is provided, the storage is opened in
89		readonly mode.
90		</p>
91
92		<p>
93		The opened storages can support read access in addition to
94		specified one.
95		</p>
96	 */
97	interface ::com::sun::star::lang::XSingleServiceFactory;
98};
99
100//============================================================================
101
102}; }; }; };
103
104#endif
105
106