1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_HierarchyBrowser_idl__ 24cdf0e10cSrcweir#define __com_sun_star_configuration_backend_HierarchyBrowser_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_task_XJob_idl__ 27cdf0e10cSrcweir#include <com/sun/star/task/XJob.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================= 31cdf0e10cSrcweir 32cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir 36cdf0e10cSrcweir/** 37cdf0e10cSrcweir allows scanning a configuration data repository for available components . 38cdf0e10cSrcweir 39*0d3a54ffSJürgen Schmidt @since OpenOffice 1.1.2 40cdf0e10cSrcweir*/ 41cdf0e10cSrcweirpublished service HierarchyBrowser 42cdf0e10cSrcweir{ 43cdf0e10cSrcweir //------------------------------------------------------------------------- 44cdf0e10cSrcweir 45cdf0e10cSrcweir /** allows executing a scan of the repository 46cdf0e10cSrcweir 47cdf0e10cSrcweir <p> The repository to browse is selected by arguments passed to 48cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member>. 49cdf0e10cSrcweir The names and meanings of such arguments depend on 50cdf0e10cSrcweir the implementation. Each implementation must document such arguments. 51cdf0e10cSrcweir </p> 52cdf0e10cSrcweir 53cdf0e10cSrcweir <p> The following argument to 54cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member> 55cdf0e10cSrcweir must be supported by all implementations: 56cdf0e10cSrcweir <dl> 57cdf0e10cSrcweir <dt><code>ExcludeComponents</code> : <atom dim="[]">string</atom> or <atom >string</atom></dt> 58cdf0e10cSrcweir <dd>A component or list of components that should be skipped 59cdf0e10cSrcweir and excluded from the result. If this argument appears multiple 60cdf0e10cSrcweir times it is handled cumulatively. 61cdf0e10cSrcweir </dd> 62cdf0e10cSrcweir </dl> 63cdf0e10cSrcweir </p> 64cdf0e10cSrcweir <p> The return value of 65cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member> 66cdf0e10cSrcweir is a list of components found. The format in which components are 67cdf0e10cSrcweir returned may depend on the implementation. Each implementation 68cdf0e10cSrcweir should support returning component identifiers that are compatible 69cdf0e10cSrcweir with some implementation of <type>Backend</type>. 70cdf0e10cSrcweir </p> 71cdf0e10cSrcweir */ 72cdf0e10cSrcweir interface com::sun::star::task::XJob ; 73cdf0e10cSrcweir 74cdf0e10cSrcweir //------------------------------------------------------------------------- 75cdf0e10cSrcweir} ; 76cdf0e10cSrcweir 77cdf0e10cSrcweir//============================================================================= 78cdf0e10cSrcweir 79cdf0e10cSrcweir} ; } ; } ; } ; } ; 80cdf0e10cSrcweir 81cdf0e10cSrcweir#endif 82