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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_ODMAContentProvider_idl__
  20 #define __com_sun_star_ucb_ODMAContentProvider_idl__
  21
  22 #include <com/sun/star/ucb/XContentProvider.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27 /** The ODMA Content Provider (OCP) implements a ContentProvider
  28     for the UniversalContentBroker (UCB).
  29
  30     <p>It provides access to a document structure stored on a Document Management System (DMS).</p>
  31
  32
  33     @see com::sun::star::ucb::ContentProvider
  34     @see com::sun::star::ucb::Content
  35     @see com::sun::star::ucb::ODMAContent
  36
  37     @since OOo 1.1.2
  38 */
  39 published service ODMAContentProvider
  40 {
  41     /** provides two types of content; the document and the Root Folder.
  42
  43         <p>
  44
  45         <ol>
  46         <li><p>The document Content corresponds to a document stored on the
  47             DMS.</p>
  48         <li><p>The Root Folder exists at any time and is used to show all
  49             documents available at that time. All other OCP contents are children
  50             of this folder. The OCP Root Folder can only contain OCP Documents.
  51             It has the URL <code><b>vnd.sun.star.odma:/</b></code>.</p>
  52         </ol>
  53
  54
  55
  56         <p><b>URL Scheme for OCP Contents</b>
  57         <p>Each OCP content has an identifier corresponding to the following
  58         scheme:</p>
  59         <p>vnd.sun.star.odma:/&lt;name&gt;</p>
  60         <p>where &lt;name&gt; is the DocumentID given by the DMS.</p>
  61         <p STYLE="font-weight: medium">Examples:</p>
  62         <p><b>vnd.sun.star.odma:/ </b><span STYLE="font-weight: medium">( The
  63         URL of the OCP Root Folder )</span></p>
  64         <p STYLE="font-weight: medium"><b>vnd.sun.star.odma:/</b> a document
  65         id given by the DMS</p>
  66         <p><b>vnd.sun.star.odma:/</b>`ODMA\DMS_ID\DM_SPECIFIC_INFO`</p>
  67
  68         </p>
  69      */
  70     interface com::sun::star::ucb::XContentProvider;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */