udkapi/com/sun/star/bridge/XBridge.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: XBridge.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_XBRIDGE_IDL_
  31 #define _COM_SUN_STAR_BRIDGE_XBRIDGE_IDL_
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34
  35 module com {  module sun {  module star {  module bridge {
  36
  37 /** main interface for an interprocess bridge.
  38  */
  39 published interface XBridge: com::sun::star::uno::XInterface
  40 {
  41     /** tries to get an interface from the remote that is known by this name.
  42
  43         <p>In general, this method is called once to get the initial object from the
  44         remote, but it is allowed to call the method multiple times. </p>
  45
  46         @param sInstanceName The name of the object, that shall be retrieved from the
  47                              remote process. The call is delegated to
  48                              com.sun.star.bridge.XInstanceProvider.getInstance() in the
  49                              remote process.
  50         @see com.sun.star.bridge.XInstanceProvider
  51      */
  52     com::sun::star::uno::XInterface getInstance( [in] string sInstanceName );
  53
  54
  55     /** name that the bridge got when it was created.
  56      */
  57     string getName();
  58
  59
  60     /** a unique descriptive string: protocol + ":" + XConnection.getDescription()
  61      */
  62     string getDescription();
  63 };
  64
  65 };};};};
  66
  67 #endif