offapi/com/sun/star/configuration/backend/Schema.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: Schema.idl,v $
  10  * $Revision: 1.8 $
  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
  31 #ifndef __com_sun_star_configuration_backend_Schema_idl__
  32 #define __com_sun_star_configuration_backend_Schema_idl__
  33
  34 #ifndef __com_sun_star_configuration_backend_XSchema_idl__
  35 #include <com/sun/star/configuration/backend/XSchema.idl>
  36 #endif
  37
  38 //==============================================================================
  39
  40 module com { module sun { module star { module configuration { module backend {
  41
  42 //==============================================================================
  43
  44 /**
  45   provides read only access to a configuration component schema.
  46
  47   <p>A component is a set of hierarchically organised and semantically
  48   related configuration settings, e.g StarWriter settings.
  49   </p>
  50   <p>A component schema contains two separate sections, one which
  51   describes the templates to be used in the dynamic containers (sets) of
  52   the component and one which describes the component's data structure.
  53   </p>
  54
  55   @see com::sun::star::configuration::backend::Layer
  56         Service providing access to individual
  57         configuration data for an entity.
  58
  59   @since OOo 1.1.2
  60   */
  61 published service Schema
  62 {
  63     //--------------------------------------------------------------------------
  64
  65     /**
  66       handles access to the schema data for a component.
  67       <p>The data can be read either in its entirety (templates and component
  68       description) or each of its parts can be accessed.
  69       </p>
  70       */
  71     interface XSchema ;
  72
  73     //--------------------------------------------------------------------------
  74
  75     /**
  76       The URL of the layer data.
  77
  78       @since OOo 2.0.0
  79       */
  80     [property,optional,readonly] string URL ;
  81
  82     //--------------------------------------------------------------------------
  83 } ;
  84
  85 //==============================================================================
  86
  87 } ; } ; } ; } ; } ;
  88
  89 #endif
  90