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