1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_configuration_backend_Layer_idl__
29#define __com_sun_star_configuration_backend_Layer_idl__
30
31#ifndef __com_sun_star_configuration_backend_XLayer_idl__
32#include <com/sun/star/configuration/backend/XLayer.idl>
33#endif
34
35#ifndef __com_sun_star_configuration_backend_XCompositeLayer_idl__
36#include <com/sun/star/configuration/backend/XCompositeLayer.idl>
37#endif
38
39#ifndef __com_sun_star_util_XTimeStamped_idl__
40#include <com/sun/star/util/XTimeStamped.idl>
41#endif
42
43//==============================================================================
44
45module com { module sun { module star { module configuration { module backend {
46
47//==============================================================================
48
49/**
50  provides read-only access to a configuration data layer.
51
52  <p> A layer contains the configuration setting changes to be performed
53  on a default settings tree to obtain the values of those settings
54  for a given entity and component.
55  </p>
56
57  @see com::sun::star::configuration::backend::Schema
58        Service providing access to schema data for a configuration component.
59
60  @see com::sun::star::configuration::backend::UpdatableLayer
61        Service providing write access to a configuration data layer.
62
63  @since OOo 1.1.2
64  */
65published service Layer
66{
67    //--------------------------------------------------------------------------
68
69    /**
70      provides read access to the contents of the configuration layer.
71      */
72    interface XLayer ;
73
74    //--------------------------------------------------------------------------
75
76    /**
77      provides read access to sublayers accessible through an
78      additional criterion (for instance the locale they contain data for).
79      */
80    [optional] interface XCompositeLayer ;
81
82    //--------------------------------------------------------------------------
83
84    /**
85      provides a way to detect changes to the layer.
86
87      <p> Timestamps should be considered as opaque markers and
88      can only safely be compared for equality and
89      only to timestamps generated by the same implementation.
90      When the content of the Layer changes,
91      the timestamp is guaranteed to change to a different value.
92      </p>
93      <p> The timestamp format depends on the implementation.
94      If the timestamp is a representation of the time of the last change,
95      the recommended format is "YYYYMMDDhhmmssZ".
96      </p>
97      */
98    [optional] interface com::sun::star::util::XTimeStamped ;
99
100    //--------------------------------------------------------------------------
101
102    /**
103      The URL of the layer data.
104
105      @since OOo 2.0
106      */
107    [property,optional,readonly] string URL ;
108
109    //--------------------------------------------------------------------------
110} ;
111
112//==============================================================================
113
114} ; } ; } ; } ; } ;
115
116#endif
117
118