offapi/com/sun/star/ucb/FetchError.idl

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