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_LayerFilter_idl__
25#define __com_sun_star_configuration_backend_LayerFilter_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_lang_XInitialization_idl__
32#include <com/sun/star/lang/XInitialization.idl>
33#endif
34
35//==============================================================================
36
37module com { module sun { module star { module configuration { module backend {
38
39//==============================================================================
40
41/**
42  provides a filtered version of a configuration data <type>Layer</type>.
43
44  <p> A layer filter wraps a source <type>XLayer</type> object and
45     provides access to a filtered version of its data.
46     The data read from the filter usually is produced from the source data
47     by adding and removing elements or modifying values.
48  </p>
49
50  @see com::sun::star::configuration::backend::DataImporter
51        Service that supports applying a <type>LayerFilter</type> to imported data.
52
53  @since OpenOffice 2.0
54  */
55published service LayerFilter
56{
57    //--------------------------------------------------------------------------
58
59    /**
60      provides read access to the filtered contents.
61
62      <p> Method <member>XLayer::readData</member> will render a filtered version
63         of the data produced by the same method of the source object.
64     </p>
65      */
66    interface XLayer ;
67
68    //--------------------------------------------------------------------------
69
70    /**
71      provides a means to set the source data for the filter.
72
73      <p> Call <method scope="com::sun::star::lang">XInitialization::initialize</method>()
74         with a single argument of type <type scope="com::sun::star::beans">NamedValue</type>,
75         where <member scope="com::sun::star::beans">NamedValue::Name</member> is <code>"Source"</code>
76         and <member scope="com::sun::star::beans">NamedValue::Value</member>
77         is an object implementing <type>XLayer</type>.
78     </p>
79      */
80    interface com::sun::star::lang::XInitialization ;
81
82    //--------------------------------------------------------------------------
83} ;
84
85//==============================================================================
86
87} ; } ; } ; } ; } ;
88
89#endif
90
91