udkapi/com/sun/star/bridge/XInstanceProvider.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: XInstanceProvider.idl,v $
  10  * $Revision: 1.12 $
  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_XINSTANCEPROVIDER_IDL_
  31 #define _COM_SUN_STAR_BRIDGE_XINSTANCEPROVIDER_IDL_
  32
  33 #include <com/sun/star/container/NoSuchElementException.idl>
  34
  35  module com {  module sun {  module star {  module bridge {
  36
  37
  38 /** allows to export UNO objects to other processes.
  39
  40     @see XBridge
  41  */
  42 published interface XInstanceProvider: com::sun::star::uno::XInterface
  43 {
  44
  45     /** gets called, when an initial object is requested from a remote process.
  46         You may either create a  new instance or return an existing object.
  47
  48        @param sInstanceName
  49             The name of the requested object.
  50
  51        @returns
  52             the object associated with the name. The return value may be null in case
  53             there is no object to offer for this string. In this case, XBridge.getInstance()
  54             (in the other process) will also return a null reference.
  55
  56        @throws NoSuchElementException
  57             You may throw this exception to indicate, that there is no object for this
  58             name. Due to a specification bug, this exception will appear as a RuntimeException
  59             at the XBridge.getInstance() method.
  60      */
  61     com::sun::star::uno::XInterface getInstance( [in] string sInstanceName )
  62             raises ( com::sun::star::container::NoSuchElementException );
  63 };
  64
  65 };};};};
  66
  67 #endif