offapi/com/sun/star/ucb/XFetchProvider.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 #ifndef __com_sun_star_ucb_XFetchProvider_idl__
  20 #define __com_sun_star_ucb_XFetchProvider_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/FetchResult.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** provides the possibility to get the contents of the columns of several
  29     rows of a ContentResultSet with a single function call.
  30 */
  31
  32 published interface XFetchProvider: com::sun::star::uno::XInterface
  33 {
  34     /** returns the contents of the columns of the indicated rows
  35
  36         @returns
  37         FetchResult::Rows contains a sequence of anys. Each
  38         of these anys contains a sequence of anys.
  39
  40         @param nRowStartPosition
  41         the starting row of the result set
  42
  43         @param nRowCount
  44         the count of rows
  45
  46         @param bDirection
  47         `TRUE`, if you want the rows to be read in the same order, as they
  48         are contained in the result set ( `TRUE` &lt;-&gt; forward step;
  49         `FALSE` &lt;-&gt; backward step )
  50     */
  51     com::sun::star::ucb::FetchResult fetch( [in] long nRowStartPosition
  52                                           , [in] long nRowCount
  53                                           , [in] boolean bDirection );
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */