offapi/com/sun/star/ucb/XContentProvider.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_XContentProvider_idl__
  20 #define __com_sun_star_ucb_XContentProvider_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/XContentIdentifier.idl>
  24 #include <com/sun/star/ucb/XContent.idl>
  25 #include <com/sun/star/ucb/IllegalIdentifierException.idl>
  26
  27
  28 module com { module sun { module star { module ucb {
  29
  30 /** a content provider which creates and manages XContents.
  31
  32      @version  1.0
  33      @author   Kai Sommerfeld
  34      @see      XContent
  35      @see      XContentIdentifier
  36 */
  37 published interface XContentProvider: com::sun::star::uno::XInterface
  38 {
  39     /** creates a new XContent instance, if the given
  40         XContentIdentifier matches a content provided by the
  41         implementation of this interface.
  42
  43         @param Identifier
  44         an identifier for the content to query.
  45
  46         @returns
  47         the content.
  48
  49         @throws IllegalIdentifierException
  50         if the given identifier does not match a content provided by the
  51         implementation of this interface
  52     */
  53     com::sun::star::ucb::XContent queryContent(
  54                 [in] com::sun::star::ucb::XContentIdentifier Identifier )
  55         raises ( com::sun::star::ucb::IllegalIdentifierException );
  56
  57     /** compares two XContentIdentifiers.
  58
  59         @param Id1
  60         first content identifier.
  61
  62         @param Id2
  63         second content identifier.
  64
  65         @returns
  66         <code>0</code> is returned, if the identifiers are equal.
  67         A value less than <code>0</code> indicates, that the Id1
  68         is less than Id2. A value greater than <code>0</code>
  69         is returned, if Id1 is greater than Id2.
  70     */
  71     long compareContentIds(
  72                 [in] com::sun::star::ucb::XContentIdentifier Id1,
  73                  [in] com::sun::star::ucb::XContentIdentifier Id2 );
  74 };
  75
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */