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_XBridgeSupplier_idl__
28#define __com_sun_star_bridge_XBridgeSupplier_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_uno_Uik_idl__
35#include <com/sun/star/uno/Uik.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module bridge {
46
47//=============================================================================
48
49
50/** defines the interface for creating bridges to other object models.
51
52	<p>Because bridges sometimes can not be generated in an address space,
53	the implementation needs to check the address space of the caller by
54	comparing the machine and process ID against its own. These IDs are
55	provided by the UNO runtime.  </p>
56
57	<p>All objects, whether they are part of the UNO object model or not,
58	are carried in an <atom>any</atom>.  The representation of this object
59	is heavily model-dependent and has to be specified in the following list: </p>
60
61	<dl>
62		<dt>UNO: </dt>
63		<dd>The any carries normal UNO types, which can be any base type,
64		struct, sequence, enum, or interface.  </dd>
65
66		<dt>OLE: 	</dt>
67		<dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems)
68		or an <atom>unsigned hyper</atom> (on 64-bit systems), which is
69		interpreted as a variant pointer. The any does not control the
70		lifetime of the represented variant. That implies that the caller
71		has the responsibility of freeing the OLE resources represented
72		by the any value.  </dd>
73
74		<dt>JAVA: 	</dt>
75		<dd>not yet specified.  </dd>
76
77		<dt>CORBA: </dt>
78		<dd>not yet specified.  </dd>
79	</dl>
80
81	<p>Any implementation can supply its own bridges to other object
82	models by implementing this interface and returning the bridge
83	when the method is called with itself as the first parameter. </p>
84
85	@see com::sun::star::bridge::OleBridgeSupplier
86	@deprecated
87 */
88published interface XBridgeSupplier: com::sun::star::uno::XInterface
89{
90
91	/** creates a bridge to provide an object of one object model with another.
92	 */
93	any createBridge( [in] any modelDepObject,
94			 [in] com::sun::star::uno::Uik MachineId,
95			 [in] long ProcessId,
96			 [in] short sourceModelType,
97			 [in] short destModelType )
98			raises( com::sun::star::lang::IllegalArgumentException );
99
100};
101
102}; }; }; };
103
104/*=============================================================================
105
106=============================================================================*/
107#endif
108