offapi/com/sun/star/report/meta/XFunctionManager.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: XReportEngine.idl,v $
  10  * $Revision: 1.5 $
  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_report_meta_XFunctionManager_idl__
  31 #define __com_sun_star_report_meta_XFunctionManager_idl__
  32
  33 #include <com/sun/star/lang/XComponent.idl>
  34 #include <com/sun/star/container/XIndexAccess.idl>
  35 #include <com/sun/star/container/NoSuchElementException.idl>
  36 #include <com/sun/star/lang/DisposedException.idl>
  37 #include <com/sun/star/report/meta/XFunctionCategory.idl>
  38 #include <com/sun/star/report/meta/XFunctionDescription.idl>
  39
  40 //=============================================================================
  41 module com {  module sun {  module star {  module report { module meta {
  42 /** identifies a <type>XFunctionManager</type> which allows to retrieve the meta data of all supported functions.
  43
  44 */
  45 interface XFunctionManager
  46 {
  47     /** allows life-time control of report engine.
  48      */
  49     interface com::sun::star::lang::XComponent;
  50     /** gives access to all categories
  51     */
  52     interface com::sun::star::container::XIndexAccess;
  53
  54     /** same as getByIndex.
  55         @param  position    The postion.
  56         @see com.ssun.star.container.XIndexAccess
  57     */
  58     XFunctionCategory getCategory([in] long position)
  59         raises( com::sun::star::lang::IndexOutOfBoundsException,
  60                     com::sun::star::lang::WrappedTargetException );
  61
  62     /** get the function description by name
  63         @param  name    the name of the function
  64     */
  65     XFunctionDescription getFunctionByName([in] string name)
  66         raises( com::sun::star::container::NoSuchElementException);
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; }; };
  72
  73 /*=============================================================================
  74
  75 =============================================================================*/
  76
  77 #endif