offapi/com/sun/star/configuration/backend/BackendAdapter.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: BackendAdapter.idl,v $
  10  * $Revision: 1.6 $
  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_configuration_backend_BackendAdapter_idl__
  31 #define __com_sun_star_configuration_backend_BackendAdapter_idl__
  32
  33 #ifndef __com_sun_star_configuration_backend_Backend_idl__
  34 #include <com/sun/star/configuration/backend/Backend.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__
  38 #include <com/sun/star/configuration/backend/XBackendEntities.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_XInitialization_idl__
  42 #include <com/sun/star/lang/XInitialization.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module configuration { module backend {
  48
  49 //=============================================================================
  50
  51 /**
  52     implements <type>Backend</type> retrieving data
  53     from a <type>SingleBackend</type>.
  54
  55     @since OOo 1.1.2
  56 */
  57 published service BackendAdapter
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** provides access to configuration data.
  62       */
  63     service Backend ;
  64
  65     //-------------------------------------------------------------------------
  66
  67     /**
  68       This interface, that is optional in <type>Backend</type>, is
  69       mandatory in this service.
  70       */
  71     interface XBackendEntities ;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /**
  76       allows initializing the backend to use.
  77
  78       <p>If this interface is present, a <type>SingleBackend</type>
  79         may be passed, that is used to access the data.
  80         Also a <type scope="com::sun::star::configuration::bootstrap">BootstrapContext</type>
  81         can be passed, that provides further settings for the backend.
  82       </p>
  83
  84       <p>If this interface is missing, the real backend to use is determined
  85         from the <type scope="com::sun::star::uno">XComponentContext</type>.
  86       </p>
  87       */
  88     [optional] interface com::sun::star::lang::XInitialization ;
  89
  90     //-------------------------------------------------------------------------
  91 } ;
  92
  93 //=============================================================================
  94
  95 } ; } ; } ; } ; } ;
  96
  97 #endif