offapi/com/sun/star/ucb/ODMAContentProvider.idl


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: ODMAContentProvider.idl,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_ODMAContentProvider_idl__
#define __com_sun_star_ucb_ODMAContentProvider_idl__

#ifndef __com_sun_star_ucb_XContentProvider_idl__
#include <com/sun/star/ucb/XContentProvider.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** The ODMA Content Provider (OCP) implements a <type>ContentProvider</type>
    for the <type>UniversalContentBroker</type> (UCB).

    <p>It provides access to a document structure stored on a Document Management System (DMS).</p>


    @see com::sun::star::ucb::ContentProvider
    @see com::sun::star::ucb::Content
    @see com::sun::star::ucb::ODMAContent

    @since OOo 1.1.2
*/
published service ODMAContentProvider
{
    //-------------------------------------------------------------------------
    /** provides two types of content; the document and the Root Folder.

        <p>

        <ol>
        <li><p>The document Content corresponds to a document stored on the
            DMS.</p>
        <li><p>The Root Folder exists at any time and is used to show all
            documents avaible at that time. All other OCP contents are children
            of this folder. The OCP Root Folder can only contain OCP Documents.
            It has the URL &bdquo;<b>vnd.sun.star.odma:/</b>&ldquo;.</p>
        </ol>


        <p><b>URL Scheme for OCP Contents</b>
        <p>Each OCP content has an identifier corresponding to the following
        scheme:</p>
        <p>vnd.sun.star.odma:/&lt;name&gt;</p>
        <p>where &lt;name&gt; is the DocumentID given by the DMS.</p>
        <p STYLE="font-weight: medium">Examples:</p>
        <p><b>vnd.sun.star.odma:/ </b><span STYLE="font-weight: medium">( The
        URL of the OCP Root Folder )</span></p>
        <p STYLE="font-weight: medium"><b>vnd.sun.star.odma:/</b> a document
        id given by the DMS</p>
        <p><b>vnd.sun.star.odma:/</b>::ODMA\DMS_ID\DM_SPECIFIC_INFO</p>

        </p>
     */
    interface com::sun::star::ucb::XContentProvider;
};

//=============================================================================

}; }; }; };

#endif