1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XFetchProvider_idl__
24#define __com_sun_star_ucb_XFetchProvider_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_FetchResult_idl__
31#include <com/sun/star/ucb/FetchResult.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module ucb {
37
38//=============================================================================
39/** provides the possibility to get the contents of the columns of several
40    rows of a <type>ContentResultSet</type> with a single function call.
41*/
42
43published interface XFetchProvider: com::sun::star::uno::XInterface
44{
45	//-------------------------------------------------------------------------
46	/** returns the contents of the columns of the indicated rows
47
48		@returns
49		<member>FetchResult::Rows</member> contains a sequence of anys. Each
50		of these anys contains a sequence of anys.
51
52		@param nRowStartPosition
53		the starting row of the resultset
54
55		@param nRowCount
56		the count of rows
57
58		@param bDirection
59		<TRUE/>, if you want the rows to be read in the same order, as they
60		are contained in the result set	( <TRUE/> &lt;-&gt; forward step;
61		<FALSE/> &lt;-&gt; backward step )
62	*/
63	com::sun::star::ucb::FetchResult fetch( [in] long nRowStartPosition
64										  , [in] long nRowCount
65										  , [in] boolean bDirection );
66};
67
68//=============================================================================
69
70}; }; }; };
71
72#endif
73