summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/bridge/XInstanceProvider.idl
blob: e075b0f9fd54bfd38a1df8f6fa10a4f2cc3904fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XInstanceProvider.idl,v $
 * $Revision: 1.12 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef _COM_SUN_STAR_BRIDGE_XINSTANCEPROVIDER_IDL_
#define _COM_SUN_STAR_BRIDGE_XINSTANCEPROVIDER_IDL_

#include <com/sun/star/container/NoSuchElementException.idl>

 module com {  module sun {  module star {  module bridge {


/** allows to export UNO objects to other processes.

    @see XBridge
 */
published interface XInstanceProvider: com::sun::star::uno::XInterface
{

    /** gets called, when an initial object is requested from a remote process.
        You may either create a  new instance or return an existing object.

       @param sInstanceName
            The name of the requested object.

       @returns
            the object associated with the name. The return value may be null in case
            there is no object to offer for this string. In this case, XBridge.getInstance()
            (in the other process) will also return a null reference.

       @throws NoSuchElementException
            You may throw this exception to indicate, that there is no object for this
            name. Due to a specification bug, this exception will appear as a RuntimeException
            at the XBridge.getInstance() method.
     */
    com::sun::star::uno::XInterface getInstance( [in] string sInstanceName )
            raises ( com::sun::star::container::NoSuchElementException );
};

};};};};

#endif