offapi/com/sun/star/ucb/XContentIdentifier.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_XContentIdentifier_idl__
  20 #define __com_sun_star_ucb_XContentIdentifier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** An identifier for contents.
  29
  30      @version  1.0
  31      @author   Kai Sommerfeld
  32      @see      XContent
  33 */
  34 published interface XContentIdentifier: com::sun::star::uno::XInterface
  35 {
  36     /** returns the content identifier string.
  37
  38         @returns
  39         the content identifier string. This must be a valid URI
  40         (Uniform Resource Identifier, see RFC 2396). This string
  41         is required. If a content provider "implements" some
  42         existent URI scheme (e.g., a content provider offering
  43         access to a file system would implement the "file" scheme,
  44         and a content provider offering access to IMAP servers
  45         would implement the "imap" scheme), the content identifier
  46         strings should use that scheme. If on the other hand a
  47         content provider offers access to content for which no
  48         appropriate URI scheme exists, a vendor-specific URL scheme
  49         starting with "vnd." must be created (see the Internet Draft
  50         draft-king-vnd-urlscheme-00.txt).
  51     */
  52     string getContentIdentifier();
  53
  54     /** returns the content provider scheme string.
  55
  56           <p>This string will   be calculated from the content identifier string
  57         and must be lower-cased(!). It is the "scheme" the content provider is
  58         registered for. In example, a provider for FTP contents will use
  59         ftp-URLs as content identifiers. The content provider scheme for all
  60         contents provided by that provider will be "ftp".
  61         </p>
  62
  63         @returns
  64         the content provider scheme string.
  65     */
  66     string getContentProviderScheme();
  67
  68 };
  69
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */