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

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