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_ODMAContentProvider_idl__
28#define __com_sun_star_ucb_ODMAContentProvider_idl__
29
30#ifndef __com_sun_star_ucb_XContentProvider_idl__
31#include <com/sun/star/ucb/XContentProvider.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module ucb {
37
38//=============================================================================
39/** The ODMA Content Provider (OCP) implements a <type>ContentProvider</type>
40    for the <type>UniversalContentBroker</type> (UCB).
41
42	<p>It provides access to a document structure stored on a Document Management System (DMS).</p>
43
44
45	@see com::sun::star::ucb::ContentProvider
46	@see com::sun::star::ucb::Content
47	@see com::sun::star::ucb::ODMAContent
48
49    @since OOo 1.1.2
50*/
51published service ODMAContentProvider
52{
53	//-------------------------------------------------------------------------
54	/** provides two types of content; the document and the Root Folder.
55
56		<p>
57
58		<ol>
59		<li><p>The document Content corresponds to a document stored on the
60			DMS.</p>
61		<li><p>The Root Folder exists at any time and is used to show all
62			documents avaible at that time. All other OCP contents are children
63			of this folder. The OCP Root Folder can only contain OCP Documents.
64			It has the URL &bdquo;<b>vnd.sun.star.odma:/</b>&ldquo;.</p>
65		</ol>
66
67
68
69		<p><b>URL Scheme for OCP Contents</b>
70		<p>Each OCP content has an identifier corresponding to the following
71		scheme:</p>
72		<p>vnd.sun.star.odma:/&lt;name&gt;</p>
73		<p>where &lt;name&gt; is the DocumentID given by the DMS.</p>
74		<p STYLE="font-weight: medium">Examples:</p>
75		<p><b>vnd.sun.star.odma:/ </b><span STYLE="font-weight: medium">( The
76		URL of the OCP Root Folder )</span></p>
77		<p STYLE="font-weight: medium"><b>vnd.sun.star.odma:/</b> a document
78		id given by the DMS</p>
79		<p><b>vnd.sun.star.odma:/</b>::ODMA\DMS_ID\DM_SPECIFIC_INFO</p>
80
81		</p>
82	 */
83	interface com::sun::star::ucb::XContentProvider;
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91