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 28#ifndef __com_sun_star_sheet_XDrillDownDataSupplier_idl__ 29#define __com_sun_star_sheet_XDrillDownDataSupplier_idl__ 30 31#ifndef __com_sun_star_uno_XInterface_idl__ 32#include <com/sun/star/uno/XInterface.idl> 33#endif 34 35#ifndef __com_sun_star_sheet_DataPilotFieldFilter_idl__ 36#include <com/sun/star/sheet/DataPilotFieldFilter.idl> 37#endif 38 39#ifndef __com_sun_star_table_CellAddress_idl__ 40#include <com/sun/star/table/CellAddress.idl> 41#endif 42 43//============================================================================= 44 45module com { module sun { module star { module sheet { 46 47//============================================================================= 48 49/** supplies a filtered subset of the original data source based on filtering criteria. 50 51 A service that acts as a DataPilot data source can optionally implement this 52 interface to allow drill-down of result data. The method this interface provides 53 is used internally when calling <method>XDataPilotTable2::getDrillDownData</method> 54 or <method>XDataPilotTable2::insertDrillDownSheet</method>. If the data source 55 service does not implement this interface, then the aformentioned two methods 56 will have no effect. 57 58 @see com::sun::star::sheet::DataPilotSource 59 60 @since OOo 3.0 61 */ 62interface XDrillDownDataSupplier: com::sun::star::uno::XInterface 63{ 64 /** This method returns filtered subset of the original source data based on 65 a given set of filtering criteria. 66 67 @param aFilters filtering criteria 68 69 @returns a filtered subset of the origintal source data as 2-dimensional 70 sequences of <type scope="com::sun::star::uno">Any</any>. The first row 71 must be the header row. Each <type scope="com::sun::star::uno">Any</type> 72 instance must contain either <type>double</type> value for a numeric cell, or 73 a <type>string</type> value for a string cell. 74 75 @see com::sun::star::sheet::DataPilotFieldFilter 76 @see com::sun::star::sheet::XDataPilotTable2 77 */ 78 sequence< sequence< any > > getDrillDownData( 79 [in] sequence< com::sun::star::sheet::DataPilotFieldFilter > aFilters ); 80}; 81 82//============================================================================= 83 84}; }; }; }; 85 86#endif 87 88