1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__
28#define __com_sun_star_ucb_XFileIdentifierConverter_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module ucb {
37
38//=============================================================================
39/** specifies methods to convert between (file) URLs and file paths in system
40	dependent notation.
41
42    @version	1.0
43    @author   	Andreas Bille
44*/
45published interface XFileIdentifierConverter : com::sun::star::uno::XInterface
46{
47	//-------------------------------------------------------------------------
48	/** Get information about the 'locality' of a file content provider.
49
50		<p>The returned information can be used to chose the 'best' among a
51		number of file content providers implementing this interface.
52
53		@param BaseURL
54		the base (file) URL used to specify a file content provider.
55
56		@returns
57		an appropriat value representing the 'locality' of the specified file
58		content provider.   Generally, higher (non-negative) numbers denote
59		file content providers that are more 'local', and negative numbers
60		denote content providers that are not file content providers at all.
61		As a convention (and to keep this useful), values should be restricted
62		to the range from -1 to +10, inclusive.
63	 */
64	long getFileProviderLocality( [in] string BaseURL );
65
66	//-------------------------------------------------------------------------
67	/** converts a file path in system dependent notation to a (file) URL.
68
69		@param BaseURL
70		the base (file) URL relative to which the file path shall be
71		interpreted.
72
73		@param SystemPath
74		a file path in system dependent notation.
75
76		@returns
77		the URL corresponding to the file path, or an empty string if the file
78		path cannot be converted into a URL.
79	*/
80	string getFileURLFromSystemPath( [in] string BaseURL,
81									 [in] string SystemPath );
82
83	//-------------------------------------------------------------------------
84	/** converts a (file) URL to a file path in system dependent notation.
85
86		@param URL
87		a (file) URL.
88
89		@returns
90		the file path corresponding to the URL, or an empty string if the URL
91		cannot be converted into a file path.
92	*/
93	string getSystemPathFromFileURL( [in] string URL );
94};
95
96//=============================================================================
97
98}; }; }; };
99
100#endif
101