offapi/com/sun/star/ucb/XFetchProviderForContentAccess.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 ucb {
  22
  23 /** provides the possibility to load information offered by a
  24     XContentAccess for several rows of a
  25     ContentResultSet with a single function call.
  26 */
  27 published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterface
  28 {
  29     /** returns the content identifier strings of the columns of the indicated
  30         rows
  31
  32         @returns
  33         FetchResult::Rows contains a sequence of anys. Each
  34         of these anys contains a string.
  35
  36         @param nRowStartPosition
  37         the starting row of the result set
  38
  39         @param nRowCount
  40         the count of rows
  41
  42         @param bDirection
  43         `TRUE`, if you want the rows to be read in the same order, as they
  44         are contained in the result set ( `TRUE` &lt;-&gt; forward step;
  45         `FALSE` &lt;-&gt; backward step )
  46     */
  47     com::sun::star::ucb::FetchResult
  48          fetchContentIdentifierStrings( [in] long nRowStartPosition
  49                                       , [in] long nRowCount
  50                                       , [in] boolean bDirection );
  51
  52     /** returns the XContentIdentifiers of the columns of the
  53         indicated rows
  54
  55         @returns
  56         FetchResult::Rows contains a sequence of anys. Each
  57         of these anys contains an XContentIdentifier.
  58
  59         @param nRowStartPosition
  60         the starting row of the result set
  61
  62         @param nRowCount
  63         the count of rows
  64
  65         @param bDirection
  66         `TRUE`, if you want the rows to be read in the same order, as they
  67         are contained in the result set ( `TRUE` &lt;-&gt; forward step;
  68         `FALSE` &lt;-&gt; backward step )
  69     */
  70     com::sun::star::ucb::FetchResult
  71          fetchContentIdentifiers( [in] long nRowStartPosition
  72                                 , [in] long nRowCount
  73                                 , [in] boolean bDirection );
  74
  75     /** returns the XContent s of the columns of the indicated rows
  76
  77         @returns
  78         FetchResult::Rows contains a sequence of anys. Each
  79         of these anys contains an XContent.
  80
  81         @param nRowStartPosition
  82         the starting row of the result set
  83
  84         @param nRowCount
  85         the count of rows
  86
  87         @param bDirection
  88         `TRUE`, if you want the rows to be read in the same order, as they
  89         are contained in the result set ( `TRUE` &lt;-&gt; forward step;
  90         `FALSE` &lt;-&gt; backward step )
  91     */
  92     com::sun::star::ucb::FetchResult
  93          fetchContents( [in] long nRowStartPosition
  94                       , [in] long nRowCount
  95                       , [in] boolean bDirection );
  96 };
  97
  98
  99 }; }; }; };
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */