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