udkapi/com/sun/star/bridge/XUnoUrlResolver.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: XUnoUrlResolver.idl,v $
  10  * $Revision: 1.13 $
  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_bridge_XUnoUrlResolver_idl__
  31 #define __com_sun_star_bridge_XUnoUrlResolver_idl__
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #include <com/sun/star/connection/ConnectionSetupException.idl>
  36 #include <com/sun/star/connection/NoConnectException.idl>
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module bridge {
  41
  42 //=============================================================================
  43
  44 /** allows to resolve an object using the uno-url.
  45  */
  46 published interface XUnoUrlResolver: com::sun::star::uno::XInterface
  47 {
  48
  49     /** resolves an object using the given uno-url.
  50         @param sUnoUrl the uno-url. The uno-url is specified
  51         <a href="http://udk.openoffice.org/common/man/spec/uno-url.html">here</a>.
  52
  53         @returns the resolved object, in general a proxy for a remote object.
  54                  You can use it the same way as you use local references.
  55      */
  56     com::sun::star::uno::XInterface resolve( [in] string sUnoUrl )
  57         raises (com::sun::star::connection::NoConnectException,
  58                 com::sun::star::connection::ConnectionSetupException,
  59                 com::sun::star::lang::IllegalArgumentException);
  60 };
  61
  62 //=============================================================================
  63
  64 }; }; }; };
  65
  66 /*=============================================================================
  67
  68 =============================================================================*/
  69 #endif