summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/ODMAContentProvider.idl
blob: b764888bd87924cfd257c9f88517e91624ccfd33 (plain)
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*************************************************************************
 *
 *  $RCSfile: ODMAContentProvider.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2003-04-17 10:18:42 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#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 #107627#
*/
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