1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_HierarchyBrowser_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_configuration_backend_HierarchyBrowser_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_task_XJob_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/task/XJob.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir//============================================================================= 35*cdf0e10cSrcweir 36*cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================= 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir/** 41*cdf0e10cSrcweir allows scanning a configuration data repository for available components . 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir @since OOo 1.1.2 44*cdf0e10cSrcweir*/ 45*cdf0e10cSrcweirpublished service HierarchyBrowser 46*cdf0e10cSrcweir{ 47*cdf0e10cSrcweir //------------------------------------------------------------------------- 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir /** allows executing a scan of the repository 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir <p> The repository to browse is selected by arguments passed to 52*cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member>. 53*cdf0e10cSrcweir The names and meanings of such arguments depend on 54*cdf0e10cSrcweir the implementation. Each implementation must document such arguments. 55*cdf0e10cSrcweir </p> 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir <p> The following argument to 58*cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member> 59*cdf0e10cSrcweir must be supported by all implementations: 60*cdf0e10cSrcweir <dl> 61*cdf0e10cSrcweir <dt><code>ExcludeComponents</code> : <atom dim="[]">string</atom> or <atom >string</atom></dt> 62*cdf0e10cSrcweir <dd>A component or list of components that should be skipped 63*cdf0e10cSrcweir and excluded from the result. If this argument appears multiple 64*cdf0e10cSrcweir times it is handled cumulatively. 65*cdf0e10cSrcweir </dd> 66*cdf0e10cSrcweir </dl> 67*cdf0e10cSrcweir </p> 68*cdf0e10cSrcweir <p> The return value of 69*cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member> 70*cdf0e10cSrcweir is a list of components found. The format in which components are 71*cdf0e10cSrcweir returned may depend on the implementation. Each implementation 72*cdf0e10cSrcweir should support returning component identifiers that are compatible 73*cdf0e10cSrcweir with some implementation of <type>Backend</type>. 74*cdf0e10cSrcweir </p> 75*cdf0e10cSrcweir */ 76*cdf0e10cSrcweir interface com::sun::star::task::XJob ; 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir //------------------------------------------------------------------------- 79*cdf0e10cSrcweir} ; 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir//============================================================================= 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir} ; } ; } ; } ; } ; 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir#endif 86