/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: FileSystemStorageFactory.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 00:04:24 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_embed_FileSystemStorageFactory_idl__
#define __com_sun_star_embed_FileSystemStorageFactory_idl__

#ifndef __com_sun_star_lang_XSingleServiceFactory_idl__ 
#include <com/sun/star/lang/XSingleServiceFactory.idl>
#endif


//============================================================================

 module com {  module sun {  module star {  module embed {

//============================================================================
/** The <type>FileSystemStorageFactory</type> is a service that allows to
	create a <type>FileSystemStorage</type> based on URL. The URL must point
	to a folder.
 */
service FileSystemStorageFactory
{
	// ----------------------------------------------------------------------
	/** A storage can be created through this interface.

		<p>
		In case
		<method scope="com::sun::star::lang">XSingleServiceFactory::createInstance</method>
		call is used the result storage will be open in readwrite mode based
		on an arbitrary file system folder.
		</p>

		<p>
		In case 
		<method scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</method>
		call is used a sequence of the following parameters can be used:
		</p>

		<dl>
			<dt>parameter 1</dt>
			<dd>
					  specifies source of the object, it must be a string
					  containing URL.
			</dd>
			
			<dt>parameter 2</dt>
			<dd>
					  specifies mode the storage should be open in, can take
					  values from <type>ElementModes</type> constant set.
			</dd>
			
			<dt>parameter 3</dt>
			<dd>
					  allowes to provide
					  <type scope="com::sun::star::document">MediaDescryptor</type>
					  to the storage so some parts can be used for
					  initialization, it can be for example
					  <type scope="com::sun::star::task">XInteractionHandler</type>
					  implementation.
			</dd>
		</dl>

		<p>
		The parameters are optional, that means that sequence can be empty or
		contain only first parameter, or first and second one. In case
		no parameters are provided the call works the same way as
		<member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>.
		In case only first parameter is provided, the storage is opened in
		readonly mode.
		</p>

		<p>
		The opened storages can support read access in addition to
		specified one.
		</p>
	 */
	interface ::com::sun::star::lang::XSingleServiceFactory;
};

//============================================================================

}; }; }; };

#endif

