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