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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** supplies a filtered subset of the original data source based on filtering criteria.
  25
  26     A service that acts as a DataPilot data source can optionally implement this
  27     interface to allow drill-down of result data.  The method this interface provides
  28     is used internally when calling XDataPilotTable2::getDrillDownData()
  29     or XDataPilotTable2::insertDrillDownSheet().  If the data source
  30     service does not implement this interface, then the aforementioned two methods
  31     will have no effect.
  32
  33     @see com::sun::star::sheet::DataPilotSource
  34
  35     @since OOo 3.0
  36  */
  37 interface XDrillDownDataSupplier: com::sun::star::uno::XInterface
  38 {
  39     /** This method returns filtered subset of the original source data based on
  40         a given set of filtering criteria.
  41
  42         @param aFilters filtering criteria
  43
  44         @returns a filtered subset of the original source data as 2-dimensional
  45         sequences of `any`.  The first row must be the header row.  Each `any`
  46         instance must contain either double value for a numeric cell, or
  47         a string value for a string cell.
  48
  49         @see com::sun::star::sheet::DataPilotFieldFilter
  50         @see com::sun::star::sheet::XDataPilotTable2
  51      */
  52     sequence< sequence< any > > getDrillDownData(
  53         [in] sequence< com::sun::star::sheet::DataPilotFieldFilter > aFilters );
  54 };
  55
  56
  57 }; }; }; };
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */