offapi/com/sun/star/configuration/backend/Layer.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: Layer.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_Layer_idl__
  32 #define __com_sun_star_configuration_backend_Layer_idl__
  33
  34 #ifndef __com_sun_star_configuration_backend_XLayer_idl__
  35 #include <com/sun/star/configuration/backend/XLayer.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_configuration_backend_XCompositeLayer_idl__
  39 #include <com/sun/star/configuration/backend/XCompositeLayer.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_util_XTimeStamped_idl__
  43 #include <com/sun/star/util/XTimeStamped.idl>
  44 #endif
  45
  46 //==============================================================================
  47
  48 module com { module sun { module star { module configuration { module backend {
  49
  50 //==============================================================================
  51
  52 /**
  53   provides read-only access to a configuration data layer.
  54
  55   <p> A layer contains the configuration setting changes to be performed
  56   on a default settings tree to obtain the values of those settings
  57   for a given entity and component.
  58   </p>
  59
  60   @see com::sun::star::configuration::backend::Schema
  61         Service providing access to schema data for a configuration component.
  62
  63   @see com::sun::star::configuration::backend::UpdatableLayer
  64         Service providing write access to a configuration data layer.
  65
  66   @since OOo 1.1.2
  67   */
  68 published service Layer
  69 {
  70     //--------------------------------------------------------------------------
  71
  72     /**
  73       provides read access to the contents of the configuration layer.
  74       */
  75     interface XLayer ;
  76
  77     //--------------------------------------------------------------------------
  78
  79     /**
  80       provides read access to sublayers accessible through an
  81       additional criterion (for instance the locale they contain data for).
  82       */
  83     [optional] interface XCompositeLayer ;
  84
  85     //--------------------------------------------------------------------------
  86
  87     /**
  88       provides a way to detect changes to the layer.
  89
  90       <p> Timestamps should be considered as opaque markers and
  91       can only safely be compared for equality and
  92       only to timestamps generated by the same implementation.
  93       When the content of the Layer changes,
  94       the timestamp is guaranteed to change to a different value.
  95       </p>
  96       <p> The timestamp format depends on the implementation.
  97       If the timestamp is a representation of the time of the last change,
  98       the recommended format is "YYYYMMDDhhmmssZ".
  99       </p>
 100       */
 101     [optional] interface com::sun::star::util::XTimeStamped ;
 102
 103     //--------------------------------------------------------------------------
 104
 105     /**
 106       The URL of the layer data.
 107
 108       @since OOo 2.0.0
 109       */
 110     [property,optional,readonly] string URL ;
 111
 112     //--------------------------------------------------------------------------
 113 } ;
 114
 115 //==============================================================================
 116
 117 } ; } ; } ; } ; } ;
 118
 119 #endif
 120