udkapi/com/sun/star/bridge/XInstanceProvider.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef _COM_SUN_STAR_BRIDGE_XINSTANCEPROVIDER_IDL_
  20 #define _COM_SUN_STAR_BRIDGE_XINSTANCEPROVIDER_IDL_
  21
  22 #include <com/sun/star/container/NoSuchElementException.idl>
  23
  24  module com {  module sun {  module star {  module bridge {
  25
  26
  27 /** allows to export UNO objects to other processes.
  28
  29     @see XBridge
  30  */
  31 published interface XInstanceProvider: com::sun::star::uno::XInterface
  32 {
  33
  34     /** gets called, when an initial object is requested from a remote process.
  35         You may either create a  new instance or return an existing object.
  36
  37        @param sInstanceName
  38             The name of the requested object.
  39
  40        @returns
  41             the object associated with the name. The return value may be null in case
  42             there is no object to offer for this string. In this case, XBridge.getInstance()
  43             (in the other process) will also return a null reference.
  44
  45        @throws NoSuchElementException
  46             You may throw this exception to indicate, that there is no object for this
  47             name. Due to a specification bug, this exception will appear as a RuntimeException
  48             at the XBridge.getInstance() method.
  49      */
  50     com::sun::star::uno::XInterface getInstance( [in] string sInstanceName )
  51             raises ( com::sun::star::container::NoSuchElementException );
  52 };
  53
  54 };};};};
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */