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