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