xref: /AOO41X/main/udkapi/com/sun/star/bridge/XInstanceProvider.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
1*408a4873SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*408a4873SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*408a4873SAndrew Rist * distributed with this work for additional information
6*408a4873SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance
9*408a4873SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*408a4873SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*408a4873SAndrew Rist * software distributed under the License is distributed on an
15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*408a4873SAndrew Rist * KIND, either express or implied.  See the License for the
17*408a4873SAndrew Rist * specific language governing permissions and limitations
18*408a4873SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*408a4873SAndrew Rist *************************************************************/
21*408a4873SAndrew Rist
22*408a4873SAndrew Rist
23cdf0e10cSrcweir#ifndef _COM_SUN_STAR_BRIDGE_XINSTANCEPROVIDER_IDL_
24cdf0e10cSrcweir#define _COM_SUN_STAR_BRIDGE_XINSTANCEPROVIDER_IDL_
25cdf0e10cSrcweir
26cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl>
27cdf0e10cSrcweir
28cdf0e10cSrcweir module com {  module sun {  module star {  module bridge {
29cdf0e10cSrcweir
30cdf0e10cSrcweir
31cdf0e10cSrcweir/** allows to export UNO objects to other processes.
32cdf0e10cSrcweir
33cdf0e10cSrcweir	@see XBridge
34cdf0e10cSrcweir */
35cdf0e10cSrcweirpublished interface XInstanceProvider: com::sun::star::uno::XInterface
36cdf0e10cSrcweir{
37cdf0e10cSrcweir
38cdf0e10cSrcweir	/** gets called, when an initial object is requested from a remote process.
39cdf0e10cSrcweir		You may either create a  new instance or return an existing object.
40cdf0e10cSrcweir
41cdf0e10cSrcweir	   @param sInstanceName
42cdf0e10cSrcweir	        The name of the requested object.
43cdf0e10cSrcweir
44cdf0e10cSrcweir	   @returns
45cdf0e10cSrcweir			the object associated with the name. The return value may be null in case
46cdf0e10cSrcweir			there is no object to offer for this string. In this case, XBridge.getInstance()
47cdf0e10cSrcweir			(in the other process) will also return a null reference.
48cdf0e10cSrcweir
49cdf0e10cSrcweir	   @throws NoSuchElementException
50cdf0e10cSrcweir	        You may throw this exception to indicate, that there is no object for this
51cdf0e10cSrcweir			name. Due to a specification bug, this exception will appear as a RuntimeException
52cdf0e10cSrcweir			at the XBridge.getInstance() method.
53cdf0e10cSrcweir	 */
54cdf0e10cSrcweir	com::sun::star::uno::XInterface getInstance( [in] string sInstanceName )
55cdf0e10cSrcweir			raises ( com::sun::star::container::NoSuchElementException );
56cdf0e10cSrcweir};
57cdf0e10cSrcweir
58cdf0e10cSrcweir};};};};
59cdf0e10cSrcweir
60cdf0e10cSrcweir#endif
61