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