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_CachedContentResultSet_idl__
28#define __com_sun_star_ucb_CachedContentResultSet_idl__
29
30#ifndef __com_sun_star_ucb_ContentResultSet_idl__
31#include <com/sun/star/ucb/ContentResultSet.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module ucb {
37
38//=============================================================================
39/** is used on client side to access a <type>ContentResultSet</type>
40	remote optimized.
41
42	<p>The <type>CachedContentResultSet</type> will not load every single
43	property or even row just in that moment you ask for it, but load the data
44	for some rows beforehand.
45
46	<p>Every time when a new package of data is loaded, the so far loaded data
47	will be released, so the cash will not grow and grow and grow.
48*/
49
50published service CachedContentResultSet
51{
52	service com::sun::star::ucb::ContentResultSet;
53
54	//-------------------------------------------------------------------------
55	/** contains the number of result set rows that should be fethched from
56	an underlying database.
57
58	<p>The default fetch size is implementation specific.
59
60	<p>Every negative value for parameter <member>FetchSize</member> will
61	force an implementation specific value to be set.
62	*/
63	[property] long FetchSize;
64
65	 //-------------------------------------------------------------------------
66	/** contains the direction for fetching rows from an underlying database.
67
68	<p>The value can be one of the
69	<type scope="com::sun::star::sdbc">FetchDirection</type> constants group.
70
71	<p>The default value is implementation specific.
72
73	<p>If you set the value to
74	<member scope="com::sun::star::sdbc">FetchDirection::UNKNOWN</member> an
75	implementation specific direction will be used.
76	*/
77	[property] long FetchDirection;
78};
79
80//=============================================================================
81
82}; }; }; };
83
84#endif
85