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#ifndef __com_sun_star_configuration_backend_LocalHierarchyBrowser_idl__
24#define __com_sun_star_configuration_backend_LocalHierarchyBrowser_idl__
25
26#ifndef __com_sun_star_configuration_backend_HierarchyBrowser_idl__
27#include <com/sun/star/configuration/backend/HierarchyBrowser.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module configuration { module backend {
33
34//=============================================================================
35
36/**
37    is a <type>HierarchyBrowser</type>, that browses a configuration database
38    stored in the local file system.
39
40    @see com::sun::star::configuration::backend::LocalSingleBackend
41
42    @since OpenOffice 1.1.2
43*/
44published service LocalHierarchyBrowser
45{
46	//-------------------------------------------------------------------------
47
48    /** allows browsing a configuration hierarchy for components.
49
50        <p> Either a schema repository or a layer directory can be browsed.
51            Components can be retrieved either as component names or as
52            file URLs.
53        </p>
54
55        <p> The following additional arguments are supported for
56            <member scope="com::sun::star::task">XJob::execute()</member>:<BR/>
57
58        <dl>
59            <dt><code>SchemaDataUrl</code> : <atom>string</atom></dt>
60            <dd>Base directory to search for schema files.
61                If this is specified, schema files will be browsed,
62                so argument <code>LayerDataUrl</code> should not be specified.
63            </dd>
64            <dt><code>LayerDataUrl</code> : <atom>string</atom></dt>
65            <dd>Base directory to search for layer files.
66                If this is specified, layer files will be browsed,
67                so argument <code>SchemaDataUrl</code> should not be specified.
68            </dd>
69            <dt><code>FetchComponentNames</code> : <atom>boolean</atom></dt>
70            <dd><ul><li>if <TRUE/> components will be returned as component names,</li>
71                    <li>if <FALSE/> components will be returned as fileURLs,</li>
72                    <li>if this argument is not provided, the default is to
73                        retrieve names when browsing schemas and URLs when
74                        browsing layers.</li>
75            </dd>
76        </dl>
77        </p>
78      */
79    service HierarchyBrowser ;
80
81	//-------------------------------------------------------------------------
82} ;
83
84//=============================================================================
85
86} ; } ; } ; } ; } ;
87
88#endif
89