xref: /aoo41x/main/udkapi/com/sun/star/bridge/XBridge.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef _COM_SUN_STAR_BRIDGE_XBRIDGE_IDL_
28#define _COM_SUN_STAR_BRIDGE_XBRIDGE_IDL_
29
30#include <com/sun/star/uno/XInterface.idl>
31
32module com {  module sun {  module star {  module bridge {
33
34/** main interface for an interprocess bridge.
35 */
36published interface XBridge: com::sun::star::uno::XInterface
37{
38	/** tries to get an interface from the remote that is known by this name.
39
40		<p>In general, this method is called once to get the initial object from the
41		remote, but it is allowed to call the method multiple times. </p>
42
43		@param sInstanceName The name of the object, that shall be retrieved from the
44		                     remote process. The call is delegated to
45							 com.sun.star.bridge.XInstanceProvider.getInstance() in the
46							 remote process.
47		@see com.sun.star.bridge.XInstanceProvider
48	 */
49	com::sun::star::uno::XInterface getInstance( [in] string sInstanceName );
50
51
52	/** name that the bridge got when it was created.
53	 */
54	string getName();
55
56
57	/** a unique descriptive string: protocol + ":" + XConnection.getDescription()
58	 */
59	string getDescription();
60};
61
62};};};};
63
64#endif
65