1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__
24cdf0e10cSrcweir#define __com_sun_star_ucb_XFileIdentifierConverter_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir//=============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir/** specifies methods to convert between (file) URLs and file paths in system
36cdf0e10cSrcweir	dependent notation.
37cdf0e10cSrcweir
38cdf0e10cSrcweir    @version	1.0
39cdf0e10cSrcweir    @author   	Andreas Bille
40cdf0e10cSrcweir*/
41cdf0e10cSrcweirpublished interface XFileIdentifierConverter : com::sun::star::uno::XInterface
42cdf0e10cSrcweir{
43cdf0e10cSrcweir	//-------------------------------------------------------------------------
44cdf0e10cSrcweir	/** Get information about the 'locality' of a file content provider.
45cdf0e10cSrcweir
46cdf0e10cSrcweir		<p>The returned information can be used to chose the 'best' among a
47cdf0e10cSrcweir		number of file content providers implementing this interface.
48cdf0e10cSrcweir
49cdf0e10cSrcweir		@param BaseURL
50cdf0e10cSrcweir		the base (file) URL used to specify a file content provider.
51cdf0e10cSrcweir
52cdf0e10cSrcweir		@returns
53cdf0e10cSrcweir		an appropriat value representing the 'locality' of the specified file
54cdf0e10cSrcweir		content provider.   Generally, higher (non-negative) numbers denote
55cdf0e10cSrcweir		file content providers that are more 'local', and negative numbers
56cdf0e10cSrcweir		denote content providers that are not file content providers at all.
57cdf0e10cSrcweir		As a convention (and to keep this useful), values should be restricted
58cdf0e10cSrcweir		to the range from -1 to +10, inclusive.
59cdf0e10cSrcweir	 */
60cdf0e10cSrcweir	long getFileProviderLocality( [in] string BaseURL );
61cdf0e10cSrcweir
62cdf0e10cSrcweir	//-------------------------------------------------------------------------
63cdf0e10cSrcweir	/** converts a file path in system dependent notation to a (file) URL.
64cdf0e10cSrcweir
65cdf0e10cSrcweir		@param BaseURL
66cdf0e10cSrcweir		the base (file) URL relative to which the file path shall be
67cdf0e10cSrcweir		interpreted.
68cdf0e10cSrcweir
69cdf0e10cSrcweir		@param SystemPath
70cdf0e10cSrcweir		a file path in system dependent notation.
71cdf0e10cSrcweir
72cdf0e10cSrcweir		@returns
73cdf0e10cSrcweir		the URL corresponding to the file path, or an empty string if the file
74cdf0e10cSrcweir		path cannot be converted into a URL.
75cdf0e10cSrcweir	*/
76cdf0e10cSrcweir	string getFileURLFromSystemPath( [in] string BaseURL,
77cdf0e10cSrcweir									 [in] string SystemPath );
78cdf0e10cSrcweir
79cdf0e10cSrcweir	//-------------------------------------------------------------------------
80cdf0e10cSrcweir	/** converts a (file) URL to a file path in system dependent notation.
81cdf0e10cSrcweir
82cdf0e10cSrcweir		@param URL
83cdf0e10cSrcweir		a (file) URL.
84cdf0e10cSrcweir
85cdf0e10cSrcweir		@returns
86cdf0e10cSrcweir		the file path corresponding to the URL, or an empty string if the URL
87cdf0e10cSrcweir		cannot be converted into a file path.
88cdf0e10cSrcweir	*/
89cdf0e10cSrcweir	string getSystemPathFromFileURL( [in] string URL );
90cdf0e10cSrcweir};
91cdf0e10cSrcweir
92cdf0e10cSrcweir//=============================================================================
93cdf0e10cSrcweir
94cdf0e10cSrcweir}; }; }; };
95cdf0e10cSrcweir
96cdf0e10cSrcweir#endif
97