xref: /aoo42x/main/offapi/com/sun/star/ucb/FetchResult.idl (revision a893be29)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_FetchResult_idl__
24cdf0e10cSrcweir#define __com_sun_star_ucb_FetchResult_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir//=============================================================================
27cdf0e10cSrcweir
28cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
29cdf0e10cSrcweir
30cdf0e10cSrcweir//=============================================================================
31cdf0e10cSrcweir/** contains data of several rows of a <type>ContentResultSet</type>.
32cdf0e10cSrcweir
33cdf0e10cSrcweir	<p>This struct is returned from <member>XFetchProvider::fetch</member>,
34cdf0e10cSrcweir	for example.
35cdf0e10cSrcweir*/
36cdf0e10cSrcweir
37cdf0e10cSrcweirpublished struct FetchResult
38cdf0e10cSrcweir{
39cdf0e10cSrcweir	//-------------------------------------------------------------------------
40cdf0e10cSrcweir    /** contains the demanded data.
41cdf0e10cSrcweir
42cdf0e10cSrcweir		<p>One any contains the data of one whole row. Those methods which
43cdf0e10cSrcweir		use this struct have to specify, what the any has to contain.
44cdf0e10cSrcweir	*/
45cdf0e10cSrcweir	sequence< any >	Rows;
46cdf0e10cSrcweir
47cdf0e10cSrcweir	//-------------------------------------------------------------------------
48cdf0e10cSrcweir    /** indicates the index of the first row contained in
49cdf0e10cSrcweir        <member>FetchResult::Rows</member> in the original resultset. So if
50cdf0e10cSrcweir        <member>FetchResult::StartIndex</member> equals <code>3</code>, the
51cdf0e10cSrcweir        first element in the sequence <member>FetchResult::Rows</member>
52cdf0e10cSrcweir        contains the data of the index <code>3</code> in the original resultset.
53cdf0e10cSrcweir
54cdf0e10cSrcweir		<p>The following rows are one after the other, but the direction
55cdf0e10cSrcweir        depends on the value of <member>FetchResult::Direction</member>
56cdf0e10cSrcweir	*/
57cdf0e10cSrcweir	long StartIndex;
58cdf0e10cSrcweir
59cdf0e10cSrcweir	//-------------------------------------------------------------------------
60cdf0e10cSrcweir	/** indicates the orientation in which the rows are fetched and set into
61cdf0e10cSrcweir        the sequence <member>FetchResult::Rows</member>.
62cdf0e10cSrcweir
63cdf0e10cSrcweir        <p>When <member>FetchResult::Orientation</member> equals <TRUE/>, the
64cdf0e10cSrcweir        rows in <member>FetchResult::Rows</member> are ordered in the same way
65cdf0e10cSrcweir        as in the original resultset.
66cdf0e10cSrcweir	*/
67cdf0e10cSrcweir	boolean	Orientation;
68cdf0e10cSrcweir
69cdf0e10cSrcweir	//-------------------------------------------------------------------------
70*a893be29SPedro Giffuni	/** indicates whether and which error has occurred, while fetching.
71cdf0e10cSrcweir
72cdf0e10cSrcweir		<p>The value may contain zero or more constants of the
73cdf0e10cSrcweir		<type>FetchError</type> constants group.
74cdf0e10cSrcweir	*/
75cdf0e10cSrcweir	short FetchError;
76cdf0e10cSrcweir};
77cdf0e10cSrcweir
78cdf0e10cSrcweir//=============================================================================
79cdf0e10cSrcweir
80cdf0e10cSrcweir}; }; }; };
81cdf0e10cSrcweir
82cdf0e10cSrcweir#endif
83