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_HierarchyBrowser_idl__
24#define __com_sun_star_configuration_backend_HierarchyBrowser_idl__
25
26#ifndef __com_sun_star_task_XJob_idl__
27#include <com/sun/star/task/XJob.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module configuration { module backend {
33
34//=============================================================================
35
36/**
37    allows scanning a configuration data repository for available components .
38
39    @since OpenOffice 1.1.2
40*/
41published service HierarchyBrowser
42{
43	//-------------------------------------------------------------------------
44
45    /** allows executing a scan of the repository
46
47        <p> The repository to browse is selected by arguments passed to
48            <member scope="com::sun::star::task">XJob::execute()</member>.
49            The names and meanings of such arguments depend on
50            the implementation. Each implementation must document such arguments.
51        </p>
52
53        <p> The following argument to
54            <member scope="com::sun::star::task">XJob::execute()</member>
55            must be supported by all implementations:
56        <dl>
57            <dt><code>ExcludeComponents</code> : <atom dim="[]">string</atom> or <atom >string</atom></dt>
58            <dd>A component or list of components that should be skipped
59                and excluded from the result. If this argument appears multiple
60                times it is handled cumulatively.
61            </dd>
62        </dl>
63        </p>
64        <p> The return value of
65            <member scope="com::sun::star::task">XJob::execute()</member>
66            is a list of components found. The format in which components are
67            returned may depend on the implementation. Each implementation
68            should support returning component identifiers that are compatible
69            with some implementation of <type>Backend</type>.
70        </p>
71      */
72    interface com::sun::star::task::XJob ;
73
74	//-------------------------------------------------------------------------
75} ;
76
77//=============================================================================
78
79} ; } ; } ; } ; } ;
80
81#endif
82