summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/registry/XImplementationRegistration.idl
blob: 40da303f53394984edb74f8dc0e15138c8f523a4 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_registry_XImplementationRegistration_idl__
#define __com_sun_star_registry_XImplementationRegistration_idl__

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

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

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



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

/** offers a registry for implementation objects and provides information
    about the registered implementations.
 */
published interface XImplementationRegistration: com::sun::star::uno::XInterface
{
    /** registers a component which provides one or more implementations.

        @param aImplementationLoader
            the URL of the implementation loader.

        @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 );

    /** 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
    /** @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
    /** @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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */