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