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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_FetchError_idl__
  20 #define __com_sun_star_ucb_FetchError_idl__
  21
  22
  23 module com { module sun { module star { module ucb {
  24
  25 /** These values are used to specify whether and which error has occurred
  26     while fetching data of some ContentResultSet rows.
  27
  28     @see FetchResult
  29 */
  30 published constants FetchError
  31 {
  32     /** indicates that fetching of data was successful.
  33     */
  34     const short SUCCESS = 0;
  35
  36     /** indicates that during fetching we went beyond the last or first row.
  37
  38         <p>Therefore the FetchResult does not contain the full
  39         count of demanded rows, but the maximum possible count must be
  40         contained.
  41     */
  42     const short ENDOFDATA = 1;
  43
  44     /** indicates that during fetching we got an exception.
  45
  46         <p>The row, that causes the exception, and all following ( "following"
  47         in read order! ) rows are not contained in the FetchResult.
  48         Therefore the FetchResult does not contain the full count
  49         of demanded rows. But all properly read rows so far must be contained.
  50     */
  51     const short EXCEPTION = 2;
  52 };
  53
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */