offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XDrillDownDataSupplier_idl__
  21 #define __com_sun_star_sheet_XDrillDownDataSupplier_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/sheet/DataPilotFieldFilter.idl>
  25 #include <com/sun/star/table/CellAddress.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** supplies a filtered subset of the original data source based on filtering criteria.
  32
  33     A service that acts as a DataPilot data source can optionally implement this
  34     interface to allow drill-down of result data.  The method this interface provides
  35     is used internally when calling XDataPilotTable2::getDrillDownData()
  36     or XDataPilotTable2::insertDrillDownSheet().  If the data source
  37     service does not implement this interface, then the aforementioned two methods
  38     will have no effect.
  39
  40     @see com::sun::star::sheet::DataPilotSource
  41
  42     @since OOo 3.0
  43  */
  44 interface XDrillDownDataSupplier: com::sun::star::uno::XInterface
  45 {
  46     /** This method returns filtered subset of the original source data based on
  47         a given set of filtering criteria.
  48
  49         @param aFilters filtering criteria
  50
  51         @returns a filtered subset of the original source data as 2-dimensional
  52         sequences of `any`.  The first row must be the header row.  Each `any`
  53         instance must contain either double value for a numeric cell, or
  54         a string value for a string cell.
  55
  56         @see com::sun::star::sheet::DataPilotFieldFilter
  57         @see com::sun::star::sheet::XDataPilotTable2
  58      */
  59     sequence< sequence< any > > getDrillDownData(
  60         [in] sequence< com::sun::star::sheet::DataPilotFieldFilter > aFilters );
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */