1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_configuration_backend_Layer_idl__
25#define __com_sun_star_configuration_backend_Layer_idl__
26
27#ifndef __com_sun_star_configuration_backend_XLayer_idl__
28#include <com/sun/star/configuration/backend/XLayer.idl>
29#endif
30
31#ifndef __com_sun_star_configuration_backend_XCompositeLayer_idl__
32#include <com/sun/star/configuration/backend/XCompositeLayer.idl>
33#endif
34
35#ifndef __com_sun_star_util_XTimeStamped_idl__
36#include <com/sun/star/util/XTimeStamped.idl>
37#endif
38
39//==============================================================================
40
41module com { module sun { module star { module configuration { module backend {
42
43//==============================================================================
44
45/**
46  provides read-only access to a configuration data layer.
47
48  <p> A layer contains the configuration setting changes to be performed
49  on a default settings tree to obtain the values of those settings
50  for a given entity and component.
51  </p>
52
53  @see com::sun::star::configuration::backend::Schema
54        Service providing access to schema data for a configuration component.
55
56  @see com::sun::star::configuration::backend::UpdatableLayer
57        Service providing write access to a configuration data layer.
58
59  @since OpenOffice 1.1.2
60  */
61published service Layer
62{
63    //--------------------------------------------------------------------------
64
65    /**
66      provides read access to the contents of the configuration layer.
67      */
68    interface XLayer ;
69
70    //--------------------------------------------------------------------------
71
72    /**
73      provides read access to sublayers accessible through an
74      additional criterion (for instance the locale they contain data for).
75      */
76    [optional] interface XCompositeLayer ;
77
78    //--------------------------------------------------------------------------
79
80    /**
81      provides a way to detect changes to the layer.
82
83      <p> Timestamps should be considered as opaque markers and
84      can only safely be compared for equality and
85      only to timestamps generated by the same implementation.
86      When the content of the Layer changes,
87      the timestamp is guaranteed to change to a different value.
88      </p>
89      <p> The timestamp format depends on the implementation.
90      If the timestamp is a representation of the time of the last change,
91      the recommended format is "YYYYMMDDhhmmssZ".
92      </p>
93      */
94    [optional] interface com::sun::star::util::XTimeStamped ;
95
96    //--------------------------------------------------------------------------
97
98    /**
99      The URL of the layer data.
100
101      @since OpenOffice 2.0
102      */
103    [property,optional,readonly] string URL ;
104
105    //--------------------------------------------------------------------------
106} ;
107
108//==============================================================================
109
110} ; } ; } ; } ; } ;
111
112#endif
113
114