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#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
24#define __com_sun_star_ucb_XContentIdentifier_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33module com { module sun { module star { module ucb {
34
35//=============================================================================
36/** An identifier for contents.
37
38     @version  1.0
39     @author   Kai Sommerfeld
40     @see      XContent
41*/
42published interface XContentIdentifier: com::sun::star::uno::XInterface
43{
44	//-------------------------------------------------------------------------
45	/**	returns the content identifier string.
46
47		@returns
48		the content identifier string. This must be a valid URI
49		(Uniform Resource Identifier, see RFC 2396). This string
50		is required. If a content provider 'implements' some
51		existent URI scheme (e.g., a content provider offering
52		access to a file system would implement the	'file' scheme,
53		and a content provider offering access to IMAP servers
54		would implement the 'imap' scheme), the content identifier
55		strings	should use that scheme. If on the other hand a
56		content provider offers access to content for which no
57		appropriate URI scheme exists, a vendor-specific URL scheme
58		starting with 'vnd.' must be created (see the Internet Draft
59		draft-king-vnd-urlscheme-00.txt).
60	*/
61	string getContentIdentifier();
62
63	//-------------------------------------------------------------------------
64	/**	returns the content provider scheme string.
65
66	  	<p>This string will	be calculated from the content identifier string
67		and must be lower-cased(!). It is the 'scheme' the content provider is
68        registered for. In example, a provider for FTP contents will use
69		ftp-URL's as content identifiers. The content provider scheme for all
70		contents provided by that provider will be "ftp".
71		</p>
72
73		@returns
74		the content provider scheme string.
75	*/
76	string getContentProviderScheme();
77
78};
79
80//=============================================================================
81
82}; }; }; };
83
84#endif
85