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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XImplementationRegistration.idl,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_registry_XImplementationRegistration_idl__
  31 #define __com_sun_star_registry_XImplementationRegistration_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_registry_XSimpleRegistry_idl__
  38 #include <com/sun/star/registry/XSimpleRegistry.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_registry_CannotRegisterImplementationException_idl__
  42 #include <com/sun/star/registry/CannotRegisterImplementationException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module registry {
  49
  50 //=============================================================================
  51
  52 // DocMerge from xml: interface com::sun::star::registry::XImplementationRegistration
  53 /** offers a registry for implementation objects and provides information
  54     about the registered implementations.
  55  */
  56 published interface XImplementationRegistration: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     // DocMerge from xml: method com::sun::star::registry::XImplementationRegistration::registerImplementation
  61     /** registers a component which provides one or more implementations.
  62
  63         @param aLocation
  64             specifies the location of the component with the URL.
  65
  66         @param xReg
  67             specifies the registry where the component should be installed.
  68             If it is a NULL interface, then the component will be installed
  69             in the system registry (if this feature is supported).
  70      */
  71     void registerImplementation( [in] string aImplementationLoader,
  72              [in] string aLocation,
  73              [in] com::sun::star::registry::XSimpleRegistry xReg )
  74             raises( com::sun::star::registry::CannotRegisterImplementationException );
  75
  76     //-------------------------------------------------------------------------
  77
  78     // DocMerge from xml: method com::sun::star::registry::XImplementationRegistration::revokeImplementation
  79     /** revokes a component and all their provided implementations from the registry.
  80
  81         @param aLocation
  82             specifies the location of the component with the URL.
  83
  84         @param xReg
  85             specifies the registry where the component should be installed.
  86             If it is a NULL interface, then the component will be revoked
  87             from the system registry (if this feature is supported).
  88      */
  89     boolean revokeImplementation( [in] string aLocation,
  90              [in] com::sun::star::registry::XSimpleRegistry xReg );
  91
  92     //-------------------------------------------------------------------------
  93     // DOCUMENTATION CHANGED FOR XImplementationRegistration::getImplementations
  94
  95     // DocMerge from idl: method com::sun::star::registry::XImplementationRegistration::getImplementations
  96     /** @returns
  97             the names of the implementations registered by the url location.
  98
  99         @param aImplementationLoader
 100             specifies the name of the needed loader for this type of implementation. For
 101             example, the loader "com.sun.star.loader.SharedLibrary" for implementations
 102             that are realized as an SharedLibrary.
 103
 104         @param aLocation
 105             specifies the location of the component with the URL.
 106      */
 107     sequence<string> getImplementations( [in] string aImplementationLoader,
 108              [in] string aLocation );
 109
 110     //-------------------------------------------------------------------------
 111     // DOCUMENTATION CHANGED FOR XImplementationRegistration::checkInstantiation
 112
 113     // DocMerge from idl: method com::sun::star::registry::XImplementationRegistration::checkInstantiation
 114     /** @returns
 115              a sequence with names of the missing services to create an instance of this implementation.
 116
 117         @param implementationName
 118             specifies the name of the checked implementation.
 119      */
 120     sequence<string> checkInstantiation( [in] string implementationName );
 121
 122 };
 123
 124 //=============================================================================
 125
 126 }; }; }; };
 127
 128 /*=============================================================================
 129
 130 =============================================================================*/
 131 #endif