offapi/com/sun/star/sheet/XDrillDownDataSupplier.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: XDrillDownDataSupplier.idl,v $
  10  *
  11  * $Revision: 1.2 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef __com_sun_star_sheet_XDrillDownDataSupplier_idl__
  33 #define __com_sun_star_sheet_XDrillDownDataSupplier_idl__
  34
  35 #ifndef __com_sun_star_uno_XInterface_idl__
  36 #include <com/sun/star/uno/XInterface.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_sheet_DataPilotFieldFilter_idl__
  40 #include <com/sun/star/sheet/DataPilotFieldFilter.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_table_CellAddress_idl__
  44 #include <com/sun/star/table/CellAddress.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module sheet {
  50
  51 //=============================================================================
  52
  53 /** supplies a filtered subset of the original data source based on filtering criteria.
  54
  55     A service that acts as a DataPilot data source can optionally implement this
  56     interface to allow drill-down of result data.  The method this interface provides
  57     is used internally when calling <method>XDataPilotTable2::getDrillDownData</method>
  58     or <method>XDataPilotTable2::insertDrillDownSheet</method>.  If the data source
  59     service does not implement this interface, then the aformentioned two methods
  60     will have no effect.
  61
  62     @see com::sun::star::sheet::DataPilotSource
  63
  64     @since OOo 3.0.0
  65  */
  66 interface XDrillDownDataSupplier: com::sun::star::uno::XInterface
  67 {
  68     /** This method returns filtered subset of the original source data based on
  69         a given set of filtering criteria.
  70
  71         @param aFilters filtering criteria
  72
  73         @returns a filtered subset of the origintal source data as 2-dimensional
  74         sequences of <type scope="com::sun::star::uno">Any</any>.  The first row
  75         must be the header row.  Each <type scope="com::sun::star::uno">Any</type>
  76         instance must contain either <type>double</type> value for a numeric cell, or
  77         a <type>string</type> value for a string cell.
  78
  79         @see com::sun::star::sheet::DataPilotFieldFilter
  80         @see com::sun::star::sheet::XDataPilotTable2
  81      */
  82     sequence< sequence< any > > getDrillDownData(
  83         [in] sequence< com::sun::star::sheet::DataPilotFieldFilter > aFilters );
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif
  91