offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl

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