1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_ODMAContentProvider_idl__
28*cdf0e10cSrcweir#define __com_sun_star_ucb_ODMAContentProvider_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentProvider_idl__
31*cdf0e10cSrcweir#include <com/sun/star/ucb/XContentProvider.idl>
32*cdf0e10cSrcweir#endif
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir//=============================================================================
35*cdf0e10cSrcweir
36*cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir//=============================================================================
39*cdf0e10cSrcweir/** The ODMA Content Provider (OCP) implements a <type>ContentProvider</type>
40*cdf0e10cSrcweir    for the <type>UniversalContentBroker</type> (UCB).
41*cdf0e10cSrcweir
42*cdf0e10cSrcweir	<p>It provides access to a document structure stored on a Document Management System (DMS).</p>
43*cdf0e10cSrcweir
44*cdf0e10cSrcweir
45*cdf0e10cSrcweir	@see com::sun::star::ucb::ContentProvider
46*cdf0e10cSrcweir	@see com::sun::star::ucb::Content
47*cdf0e10cSrcweir	@see com::sun::star::ucb::ODMAContent
48*cdf0e10cSrcweir
49*cdf0e10cSrcweir    @since OOo 1.1.2
50*cdf0e10cSrcweir*/
51*cdf0e10cSrcweirpublished service ODMAContentProvider
52*cdf0e10cSrcweir{
53*cdf0e10cSrcweir	//-------------------------------------------------------------------------
54*cdf0e10cSrcweir	/** provides two types of content; the document and the Root Folder.
55*cdf0e10cSrcweir
56*cdf0e10cSrcweir		<p>
57*cdf0e10cSrcweir
58*cdf0e10cSrcweir		<ol>
59*cdf0e10cSrcweir		<li><p>The document Content corresponds to a document stored on the
60*cdf0e10cSrcweir			DMS.</p>
61*cdf0e10cSrcweir		<li><p>The Root Folder exists at any time and is used to show all
62*cdf0e10cSrcweir			documents avaible at that time. All other OCP contents are children
63*cdf0e10cSrcweir			of this folder. The OCP Root Folder can only contain OCP Documents.
64*cdf0e10cSrcweir			It has the URL &bdquo;<b>vnd.sun.star.odma:/</b>&ldquo;.</p>
65*cdf0e10cSrcweir		</ol>
66*cdf0e10cSrcweir
67*cdf0e10cSrcweir
68*cdf0e10cSrcweir
69*cdf0e10cSrcweir		<p><b>URL Scheme for OCP Contents</b>
70*cdf0e10cSrcweir		<p>Each OCP content has an identifier corresponding to the following
71*cdf0e10cSrcweir		scheme:</p>
72*cdf0e10cSrcweir		<p>vnd.sun.star.odma:/&lt;name&gt;</p>
73*cdf0e10cSrcweir		<p>where &lt;name&gt; is the DocumentID given by the DMS.</p>
74*cdf0e10cSrcweir		<p STYLE="font-weight: medium">Examples:</p>
75*cdf0e10cSrcweir		<p><b>vnd.sun.star.odma:/ </b><span STYLE="font-weight: medium">( The
76*cdf0e10cSrcweir		URL of the OCP Root Folder )</span></p>
77*cdf0e10cSrcweir		<p STYLE="font-weight: medium"><b>vnd.sun.star.odma:/</b> a document
78*cdf0e10cSrcweir		id given by the DMS</p>
79*cdf0e10cSrcweir		<p><b>vnd.sun.star.odma:/</b>::ODMA\DMS_ID\DM_SPECIFIC_INFO</p>
80*cdf0e10cSrcweir
81*cdf0e10cSrcweir		</p>
82*cdf0e10cSrcweir	 */
83*cdf0e10cSrcweir	interface com::sun::star::ucb::XContentProvider;
84*cdf0e10cSrcweir};
85*cdf0e10cSrcweir
86*cdf0e10cSrcweir//=============================================================================
87*cdf0e10cSrcweir
88*cdf0e10cSrcweir}; }; }; };
89*cdf0e10cSrcweir
90*cdf0e10cSrcweir#endif
91