1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XDrillDownDataSupplier_idl__
25#define __com_sun_star_sheet_XDrillDownDataSupplier_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_DataPilotFieldFilter_idl__
32#include <com/sun/star/sheet/DataPilotFieldFilter.idl>
33#endif
34
35#ifndef __com_sun_star_table_CellAddress_idl__
36#include <com/sun/star/table/CellAddress.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module sheet {
42
43//=============================================================================
44
45/** supplies a filtered subset of the original data source based on filtering criteria.
46
47    A service that acts as a DataPilot data source can optionally implement this
48    interface to allow drill-down of result data.  The method this interface provides
49    is used internally when calling <method>XDataPilotTable2::getDrillDownData</method>
50    or <method>XDataPilotTable2::insertDrillDownSheet</method>.  If the data source
51    service does not implement this interface, then the aformentioned two methods
52    will have no effect.
53
54    @see com::sun::star::sheet::DataPilotSource
55
56    @since OOo 3.0
57 */
58interface XDrillDownDataSupplier: com::sun::star::uno::XInterface
59{
60    /** This method returns filtered subset of the original source data based on
61        a given set of filtering criteria.
62
63        @param aFilters filtering criteria
64
65        @returns a filtered subset of the origintal source data as 2-dimensional
66        sequences of <type scope="com::sun::star::uno">Any</any>.  The first row
67        must be the header row.  Each <type scope="com::sun::star::uno">Any</type>
68        instance must contain either <type>double</type> value for a numeric cell, or
69        a <type>string</type> value for a string cell.
70
71        @see com::sun::star::sheet::DataPilotFieldFilter
72        @see com::sun::star::sheet::XDataPilotTable2
73     */
74    sequence< sequence< any > > getDrillDownData(
75        [in] sequence< com::sun::star::sheet::DataPilotFieldFilter > aFilters );
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83
84