offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.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_XRemoteContentProviderSupplier_idl__
  28 #define __com_sun_star_ucb_XRemoteContentProviderSupplier_idl__
  29
  30 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  31 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module ucb {
  42
  43 //=============================================================================
  44 /** Provide access to a collection of remote content providers.
  45
  46     @version 1.0
  47     @author Stephan Bergmann
  48     @see XRemoteContentProviderAcceptor
  49 */
  50 published interface XRemoteContentProviderSupplier: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53     /** Get a factory through which a remote content provider's
  54         <type>UniversalContentBroker</type> service can be instantiated.
  55
  56         @param Identifier  An arbitrary identifier uniquely identifying a
  57         remote content provider.
  58
  59         @return  the appropriate factory, or null if none is available.
  60     */
  61     com::sun::star::lang::XMultiServiceFactory
  62     queryRemoteContentProvider([in] string Identifier);
  63 };
  64
  65 //=============================================================================
  66
  67 }; }; }; };
  68
  69 #endif