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