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