offapi/com/sun/star/ucb/XFetchProvider.idl


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_ucb_XFetchProvider_idl__
#define __com_sun_star_ucb_XFetchProvider_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/ucb/FetchResult.idl>


module com { module sun { module star { module ucb {

/** provides the possibility to get the contents of the columns of several
    rows of a ContentResultSet with a single function call.
*/

published interface XFetchProvider: com::sun::star::uno::XInterface
{
    /** returns the contents of the columns of the indicated rows

        @returns
        FetchResult::Rows contains a sequence of anys. Each
        of these anys contains a sequence of anys.

        @param nRowStartPosition
        the starting row of the result set

        @param nRowCount
        the count of rows

        @param bDirection
        `TRUE`, if you want the rows to be read in the same order, as they
        are contained in the result set ( `TRUE` &lt;-&gt; forward step;
        `FALSE` &lt;-&gt; backward step )
    */
    com::sun::star::ucb::FetchResult fetch( [in] long nRowStartPosition
                                          , [in] long nRowCount
                                          , [in] boolean bDirection );
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */