summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/FetchError.idl
blob: 92cc2fad12fc65ad0be4ab5c33f5f182d5d50ab6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_ucb_FetchError_idl__
#define __com_sun_star_ucb_FetchError_idl__

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** These values are used to specify whether and which error has occured
    while fetching data of some <type>ContentResultSet</type> rows.

    @see FetchResult
*/
published constants FetchError
{
    //-------------------------------------------------------------------------
    /** indicates that fetching of data was successful.
    */
    const short SUCCESS = 0;

    //-------------------------------------------------------------------------
    /** indicates that during fetching we went beyond the last or first row.

        <p>Therefore the <type>FetchResult</type> does not contain the full
        count of demanded rows, but the maximum possible count must be
        contained.
    */
    const short ENDOFDATA = 1;

    //-------------------------------------------------------------------------
    /** indicates that during fetching we got an exception.

        <p>The row, that causes the exceptione, and all following ( 'following'
        in readorder! ) rows are not contained in the <type>FetchResult</type>.
        Therefore the <type>FetchResult</type> does not contain the full count
        of demanded rows. But all properly readed rows so far must be contained.
    */
    const short EXCEPTION = 2;
};

//=============================================================================

}; }; }; };

#endif