xref: /aoo42x/main/offapi/com/sun/star/ucb/FetchError.idl (revision cdf0e10c)
1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_ucb_FetchError_idl__
28*cdf0e10cSrcweir#define __com_sun_star_ucb_FetchError_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir//=============================================================================
31*cdf0e10cSrcweir
32*cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir//=============================================================================
35*cdf0e10cSrcweir/** These values are used to specify whether and which error has occured
36*cdf0e10cSrcweir    while fetching data of some <type>ContentResultSet</type> rows.
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir	@see FetchResult
39*cdf0e10cSrcweir*/
40*cdf0e10cSrcweirpublished constants FetchError
41*cdf0e10cSrcweir{
42*cdf0e10cSrcweir	//-------------------------------------------------------------------------
43*cdf0e10cSrcweir	/** indicates that fetching of data was successful.
44*cdf0e10cSrcweir	*/
45*cdf0e10cSrcweir	const short SUCCESS = 0;
46*cdf0e10cSrcweir
47*cdf0e10cSrcweir	//-------------------------------------------------------------------------
48*cdf0e10cSrcweir	/** indicates that during fetching we went beyond the last or first row.
49*cdf0e10cSrcweir
50*cdf0e10cSrcweir		<p>Therefore the <type>FetchResult</type> does not contain the full
51*cdf0e10cSrcweir		count of demanded rows, but the maximum possible count must be
52*cdf0e10cSrcweir		contained.
53*cdf0e10cSrcweir	*/
54*cdf0e10cSrcweir	const short ENDOFDATA = 1;
55*cdf0e10cSrcweir
56*cdf0e10cSrcweir	//-------------------------------------------------------------------------
57*cdf0e10cSrcweir	/** indicates that during fetching we got an exception.
58*cdf0e10cSrcweir
59*cdf0e10cSrcweir		<p>The row, that causes the exceptione, and all following ( 'following'
60*cdf0e10cSrcweir		in readorder! ) rows are not contained in the <type>FetchResult</type>.
61*cdf0e10cSrcweir		Therefore the <type>FetchResult</type> does not contain the full count
62*cdf0e10cSrcweir		of demanded rows. But all properly readed rows so far must be contained.
63*cdf0e10cSrcweir	*/
64*cdf0e10cSrcweir	const short EXCEPTION = 2;
65*cdf0e10cSrcweir};
66*cdf0e10cSrcweir
67*cdf0e10cSrcweir//=============================================================================
68*cdf0e10cSrcweir
69*cdf0e10cSrcweir}; }; }; };
70*cdf0e10cSrcweir
71*cdf0e10cSrcweir#endif
72