offapi/com/sun/star/configuration/backend/Backend.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: Backend.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_Backend_idl__
  31 #define __com_sun_star_configuration_backend_Backend_idl__
  32
  33 #ifndef __com_sun_star_configuration_backend_XBackend_idl__
  34 #include <com/sun/star/configuration/backend/XBackend.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_configuration_backend_XSchemaSupplier_idl__
  42 #include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module configuration { module backend {
  48
  49 //=============================================================================
  50
  51 /**
  52     provides access to a configuration database composed of one or more
  53     storage backends containing settings used by software modules.
  54
  55     <p> Configuration data is organized into layers which are selected
  56         by components and entities.
  57     </p>
  58
  59     <p> Components are characterized by configuration schemas.
  60         A component contains configuration data for a particular
  61         application domain or software module.
  62     </p>
  63     <p> Entities are organised hierarchically in organisations,
  64         groups, roles and individual users. Each element of the associated
  65         hierarchy corresponds to a layer that applies to an entity.
  66     </p>
  67     <p> A layer contains data for multiple components
  68         associated to a single entity.
  69     <p>
  70
  71     @since OOo 1.1.2
  72 */
  73 published service Backend
  74 {
  75     //-------------------------------------------------------------------------
  76
  77     /**
  78       provides access to configuration schemas.
  79       */
  80     interface XSchemaSupplier ;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /**
  85       provides access to the layer data.
  86       */
  87     interface XBackend ;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /**
  92       provides information about supported and special entities.
  93       */
  94     [optional] interface XBackendEntities ;
  95
  96     //-------------------------------------------------------------------------
  97 } ;
  98
  99 //=============================================================================
 100
 101 } ; } ; } ; } ; } ;
 102
 103 #endif