xref: /aoo42x/main/offapi/com/sun/star/ucb/FetchError.idl (revision a893be29)
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_FetchError_idl__
24#define __com_sun_star_ucb_FetchError_idl__
25
26//=============================================================================
27
28module com { module sun { module star { module ucb {
29
30//=============================================================================
31/** These values are used to specify whether and which error has occurred
32    while fetching data of some <type>ContentResultSet</type> rows.
33
34	@see FetchResult
35*/
36published constants FetchError
37{
38	//-------------------------------------------------------------------------
39	/** indicates that fetching of data was successful.
40	*/
41	const short SUCCESS = 0;
42
43	//-------------------------------------------------------------------------
44	/** indicates that during fetching we went beyond the last or first row.
45
46		<p>Therefore the <type>FetchResult</type> does not contain the full
47		count of demanded rows, but the maximum possible count must be
48		contained.
49	*/
50	const short ENDOFDATA = 1;
51
52	//-------------------------------------------------------------------------
53	/** indicates that during fetching we got an exception.
54
55		<p>The row, that causes the exceptione, and all following ( 'following'
56		in readorder! ) rows are not contained in the <type>FetchResult</type>.
57		Therefore the <type>FetchResult</type> does not contain the full count
58		of demanded rows. But all properly readed rows so far must be contained.
59	*/
60	const short EXCEPTION = 2;
61};
62
63//=============================================================================
64
65}; }; }; };
66
67#endif
68