/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_configuration_backend_LocalHierarchyBrowser_idl__ #define __com_sun_star_configuration_backend_LocalHierarchyBrowser_idl__ #ifndef __com_sun_star_configuration_backend_HierarchyBrowser_idl__ #include #endif //============================================================================= module com { module sun { module star { module configuration { module backend { //============================================================================= /** is a HierarchyBrowser, that browses a configuration database stored in the local file system. @see com::sun::star::configuration::backend::LocalSingleBackend @since OOo 1.1.2 */ published service LocalHierarchyBrowser { //------------------------------------------------------------------------- /** allows browsing a configuration hierarchy for components.

Either a schema repository or a layer directory can be browsed. Components can be retrieved either as component names or as file URLs.

The following additional arguments are supported for XJob::execute():

SchemaDataUrl : string
Base directory to search for schema files. If this is specified, schema files will be browsed, so argument LayerDataUrl should not be specified.
LayerDataUrl : string
Base directory to search for layer files. If this is specified, layer files will be browsed, so argument SchemaDataUrl should not be specified.
FetchComponentNames : boolean
  • if components will be returned as component names,
  • if components will be returned as fileURLs,
  • if this argument is not provided, the default is to retrieve names when browsing schemas and URLs when browsing layers.

*/ service HierarchyBrowser ; //------------------------------------------------------------------------- } ; //============================================================================= } ; } ; } ; } ; } ; #endif