offapi/com/sun/star/ucb/XContentProvider.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: XContentProvider.idl,v $
  10  * $Revision: 1.11 $
  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_XContentProvider_idl__
  31 #define __com_sun_star_ucb_XContentProvider_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContentIdentifier_idl__
  38 #include <com/sun/star/ucb/XContentIdentifier.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XContent_idl__
  42 #include <com/sun/star/ucb/XContent.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_ucb_IllegalIdentifierException_idl__
  46 #include <com/sun/star/ucb/IllegalIdentifierException.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module ucb {
  52
  53 //=============================================================================
  54 /** a content provider which creates and manages <type>XContent</type>s.
  55
  56      @version  1.0
  57      @author   Kai Sommerfeld
  58      @see      XContent
  59      @see          XContentIdentifier
  60 */
  61 published interface XContentProvider: com::sun::star::uno::XInterface
  62 {
  63     //-------------------------------------------------------------------------
  64     /** creates a new <type>XContent</type> instance, if the given
  65         <type>XContentIdentifier</type> matches a content provided by the
  66         implementation of this interface.
  67
  68         @param Identifier
  69         an identifier for the content to query.
  70
  71         @returns
  72         the content.
  73
  74         @throws IllegalIdentifierException
  75         if the given identifier does not match a content provided by the
  76         implementation of this interface
  77     */
  78     com::sun::star::ucb::XContent queryContent(
  79                 [in] com::sun::star::ucb::XContentIdentifier Identifier )
  80         raises ( com::sun::star::ucb::IllegalIdentifierException );
  81
  82     //-------------------------------------------------------------------------
  83     /** compares two <type>XContentIdentifier</type>s.
  84
  85         @param Id1
  86         first content identifier.
  87
  88         @param Id2
  89         second content identifier.
  90
  91         @returns
  92         <code>0</code> is returned, if the identifiers are equal.
  93         A value less than <code>0</code> indiactes, that the Id1
  94         is less than Id2. A value greater than <code>0</code>
  95         is returned, if Id1 is greater than Id2.
  96     */
  97     long compareContentIds(
  98                 [in] com::sun::star::ucb::XContentIdentifier Id1,
  99                  [in] com::sun::star::ucb::XContentIdentifier Id2 );
 100 };
 101
 102 //=============================================================================
 103
 104 }; }; }; };
 105
 106 #endif