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 #ifndef __com_sun_star_registry_XImplementationRegistration_idl__
  20 #define __com_sun_star_registry_XImplementationRegistration_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/registry/XSimpleRegistry.idl>
  25
  26 #include <com/sun/star/registry/CannotRegisterImplementationException.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module registry {
  31
  32 /** offers a registry for implementation objects and provides information
  33     about the registered implementations.
  34  */
  35 published interface XImplementationRegistration: com::sun::star::uno::XInterface
  36 {
  37     /** registers a component which provides one or more implementations.
  38
  39         @param aLocation
  40             specifies the location of the component with the URL.
  41
  42         @param xReg
  43             specifies the registry where the component should be installed.
  44             If it is a NULL interface, then the component will be installed
  45             in the system registry (if this feature is supported).
  46      */
  47     void registerImplementation( [in] string aImplementationLoader,
  48              [in] string aLocation,
  49              [in] com::sun::star::registry::XSimpleRegistry xReg )
  50             raises( com::sun::star::registry::CannotRegisterImplementationException );
  51
  52     /** revokes a component and all their provided implementations from the registry.
  53
  54         @param aLocation
  55             specifies the location of the component with the URL.
  56
  57         @param xReg
  58             specifies the registry where the component should be installed.
  59             If it is a NULL interface, then the component will be revoked
  60             from the system registry (if this feature is supported).
  61      */
  62     boolean revokeImplementation( [in] string aLocation,
  63              [in] com::sun::star::registry::XSimpleRegistry xReg );
  64
  65     // DOCUMENTATION CHANGED FOR XImplementationRegistration::getImplementations
  66     /** @returns
  67             the names of the implementations registered by the url location.
  68
  69         @param aImplementationLoader
  70             specifies the name of the needed loader for this type of implementation. For
  71             example, the loader "com.sun.star.loader.SharedLibrary" for implementations
  72             that are realized as an SharedLibrary.
  73
  74         @param aLocation
  75             specifies the location of the component with the URL.
  76      */
  77     sequence<string> getImplementations( [in] string aImplementationLoader,
  78              [in] string aLocation );
  79
  80     // DOCUMENTATION CHANGED FOR XImplementationRegistration::checkInstantiation
  81     /** @returns
  82              a sequence with names of the missing services to create an instance of this implementation.
  83
  84         @param implementationName
  85             specifies the name of the checked implementation.
  86      */
  87     sequence<string> checkInstantiation( [in] string implementationName );
  88
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */