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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  28 #define __com_sun_star_ucb_XContentProvider_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_ucb_XContentIdentifier_idl__
  35 #include <com/sun/star/ucb/XContentIdentifier.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_ucb_XContent_idl__
  39 #include <com/sun/star/ucb/XContent.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_ucb_IllegalIdentifierException_idl__
  43 #include <com/sun/star/ucb/IllegalIdentifierException.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** a content provider which creates and manages <type>XContent</type>s.
  52
  53      @version  1.0
  54      @author   Kai Sommerfeld
  55      @see      XContent
  56      @see      XContentIdentifier
  57 */
  58 published interface XContentProvider: com::sun::star::uno::XInterface
  59 {
  60     //-------------------------------------------------------------------------
  61     /** creates a new <type>XContent</type> instance, if the given
  62         <type>XContentIdentifier</type> matches a content provided by the
  63         implementation of this interface.
  64
  65         @param Identifier
  66         an identifier for the content to query.
  67
  68         @returns
  69         the content.
  70
  71         @throws IllegalIdentifierException
  72         if the given identifier does not match a content provided by the
  73         implementation of this interface
  74     */
  75     com::sun::star::ucb::XContent queryContent(
  76                 [in] com::sun::star::ucb::XContentIdentifier Identifier )
  77         raises ( com::sun::star::ucb::IllegalIdentifierException );
  78
  79     //-------------------------------------------------------------------------
  80     /** compares two <type>XContentIdentifier</type>s.
  81
  82         @param Id1
  83         first content identifier.
  84
  85         @param Id2
  86         second content identifier.
  87
  88         @returns
  89         <code>0</code> is returned, if the identifiers are equal.
  90         A value less than <code>0</code> indiactes, that the Id1
  91         is less than Id2. A value greater than <code>0</code>
  92         is returned, if Id1 is greater than Id2.
  93     */
  94     long compareContentIds(
  95                 [in] com::sun::star::ucb::XContentIdentifier Id1,
  96                  [in] com::sun::star::ucb::XContentIdentifier Id2 );
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif