1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ucb_XFetchProvider_idl__
28#define __com_sun_star_ucb_XFetchProvider_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_ucb_FetchResult_idl__
35#include <com/sun/star/ucb/FetchResult.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module ucb {
41
42//=============================================================================
43/** provides the possibility to get the contents of the columns of several
44    rows of a <type>ContentResultSet</type> with a single function call.
45*/
46
47published interface XFetchProvider: com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50	/** returns the contents of the columns of the indicated rows
51
52		@returns
53		<member>FetchResult::Rows</member> contains a sequence of anys. Each
54		of these anys contains a sequence of anys.
55
56		@param nRowStartPosition
57		the starting row of the resultset
58
59		@param nRowCount
60		the count of rows
61
62		@param bDirection
63		<TRUE/>, if you want the rows to be read in the same order, as they
64		are contained in the result set	( <TRUE/> &lt;-&gt; forward step;
65		<FALSE/> &lt;-&gt; backward step )
66	*/
67	com::sun::star::ucb::FetchResult fetch( [in] long nRowStartPosition
68										  , [in] long nRowCount
69										  , [in] boolean bDirection );
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77