1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_report_meta_XFunctionManager_idl__
28#define __com_sun_star_report_meta_XFunctionManager_idl__
29
30#include <com/sun/star/lang/XComponent.idl>
31#include <com/sun/star/container/XIndexAccess.idl>
32#include <com/sun/star/container/NoSuchElementException.idl>
33#include <com/sun/star/lang/DisposedException.idl>
34#include <com/sun/star/report/meta/XFunctionCategory.idl>
35#include <com/sun/star/report/meta/XFunctionDescription.idl>
36
37//=============================================================================
38module com {  module sun {  module star {  module report { module meta {
39/** identifies a <type>XFunctionManager</type> which allows to retrieve the meta data of all supported functions.
40
41*/
42published interface XFunctionManager
43{
44    /** allows life-time control of report engine.
45     */
46    interface com::sun::star::lang::XComponent;
47    /** gives access to all categories
48    */
49    interface com::sun::star::container::XIndexAccess;
50
51    /** same as getByIndex.
52        @param  position    The postion.
53        @see com.ssun.star.container.XIndexAccess
54    */
55    XFunctionCategory getCategory([in] long position)
56        raises( com::sun::star::lang::IndexOutOfBoundsException,
57                    com::sun::star::lang::WrappedTargetException );
58
59    /** get the function description by name
60        @param  name    the name of the function
61    */
62    XFunctionDescription getFunctionByName([in] string name)
63        raises( com::sun::star::container::NoSuchElementException);
64};
65
66//=============================================================================
67
68}; }; }; }; };
69
70/*=============================================================================
71
72=============================================================================*/
73
74#endif
75