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