summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/registry/XImplementationRegistration.idl
blob: b46cbba4493abd951c0cdda77da8d292bf19b0b6 (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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*************************************************************************
 *
 * 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: XImplementationRegistration.idl,v $
 * $Revision: 1.14 $
 *
 * 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_registry_XImplementationRegistration_idl__
#define __com_sun_star_registry_XImplementationRegistration_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_registry_XSimpleRegistry_idl__
#include <com/sun/star/registry/XSimpleRegistry.idl>
#endif

#ifndef __com_sun_star_registry_CannotRegisterImplementationException_idl__
#include <com/sun/star/registry/CannotRegisterImplementationException.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module registry {

//=============================================================================

// DocMerge from xml: interface com::sun::star::registry::XImplementationRegistration
/** offers a registry for implementation objects and provides information
    about the registered implementations.
 */
published interface XImplementationRegistration: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::registry::XImplementationRegistration::registerImplementation
    /** registers a component which provides one or more implementations.

        @param aLocation
            specifies the location of the component with the URL.

        @param xReg
            specifies the registry where the component should be installed.
            If it is a NULL interface, then the component will be installed
            in the system registry (if this feature is supported).
     */
    void registerImplementation( [in] string aImplementationLoader,
             [in] string aLocation,
             [in] com::sun::star::registry::XSimpleRegistry xReg )
            raises( com::sun::star::registry::CannotRegisterImplementationException );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::registry::XImplementationRegistration::revokeImplementation
    /** revokes a component and all their provided implementations from the registry.

        @param aLocation
            specifies the location of the component with the URL.

        @param xReg
            specifies the registry where the component should be installed.
            If it is a NULL interface, then the component will be revoked
            from the system registry (if this feature is supported).
     */
    boolean revokeImplementation( [in] string aLocation,
             [in] com::sun::star::registry::XSimpleRegistry xReg );

    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR XImplementationRegistration::getImplementations

    // DocMerge from idl: method com::sun::star::registry::XImplementationRegistration::getImplementations
    /** @returns
            the names of the implementations registered by the url location.

        @param aImplementationLoader
            specifies the name of the needed loader for this type of implementation. For
            example, the loader "com.sun.star.loader.SharedLibrary" for implementations
            that are realized as an SharedLibrary.

        @param aLocation
            specifies the location of the component with the URL.
     */
    sequence<string> getImplementations( [in] string aImplementationLoader,
             [in] string aLocation );

    //-------------------------------------------------------------------------
    // DOCUMENTATION CHANGED FOR XImplementationRegistration::checkInstantiation

    // DocMerge from idl: method com::sun::star::registry::XImplementationRegistration::checkInstantiation
    /** @returns
             a sequence with names of the missing services to create an instance of this implementation.

        @param implementationName
            specifies the name of the checked implementation.
     */
    sequence<string> checkInstantiation( [in] string implementationName );

};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif