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