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

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