udkapi/com/sun/star/registry/XImplementationRegistration.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module registry {
  23
  24 /** offers a registry for implementation objects and provides information
  25     about the registered implementations.
  26  */
  27 published interface XImplementationRegistration: com::sun::star::uno::XInterface
  28 {
  29     /** registers a component which provides one or more implementations.
  30
  31         @param aImplementationLoader
  32             the URL of the implementation loader.
  33
  34         @param aLocation
  35             specifies the location of the component with the URL.
  36
  37         @param xReg
  38             specifies the registry where the component should be installed.
  39             If it is a NULL interface, then the component will be installed
  40             in the system registry (if this feature is supported).
  41      */
  42     void registerImplementation( [in] string aImplementationLoader,
  43              [in] string aLocation,
  44              [in] com::sun::star::registry::XSimpleRegistry xReg )
  45             raises( com::sun::star::registry::CannotRegisterImplementationException );
  46
  47     /** revokes a component and all their provided implementations from the registry.
  48
  49         @param aLocation
  50             specifies the location of the component with the URL.
  51
  52         @param xReg
  53             specifies the registry where the component should be installed.
  54             If it is a NULL interface, then the component will be revoked
  55             from the system registry (if this feature is supported).
  56      */
  57     boolean revokeImplementation( [in] string aLocation,
  58              [in] com::sun::star::registry::XSimpleRegistry xReg );
  59
  60     // DOCUMENTATION CHANGED FOR XImplementationRegistration::getImplementations
  61     /** @returns
  62             the names of the implementations registered by the url location.
  63
  64         @param aImplementationLoader
  65             specifies the name of the needed loader for this type of implementation. For
  66             example, the loader "com.sun.star.loader.SharedLibrary" for implementations
  67             that are realized as an SharedLibrary.
  68
  69         @param aLocation
  70             specifies the location of the component with the URL.
  71      */
  72     sequence<string> getImplementations( [in] string aImplementationLoader,
  73              [in] string aLocation );
  74
  75     // DOCUMENTATION CHANGED FOR XImplementationRegistration::checkInstantiation
  76     /** @returns
  77              a sequence with names of the missing services to create an instance of this implementation.
  78
  79         @param implementationName
  80             specifies the name of the checked implementation.
  81      */
  82     sequence<string> checkInstantiation( [in] string implementationName );
  83
  84 };
  85
  86
  87 }; }; }; };
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */