offapi/com/sun/star/sdbc/DataTruncation.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_sdbc_DataTruncation_idl__
  28 #define __com_sun_star_sdbc_DataTruncation_idl__
  29
  30 #ifndef __com_sun_star_sdbc_SQLWarning_idl__
  31 #include <com/sun/star/sdbc/SQLWarning.idl>
  32 #endif
  33
  34  module com {  module sun {  module star {  module sdbc {
  35
  36
  37 /** reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception,
  38     on writes, when a data value is unexpectedly truncated.
  39
  40     <p>
  41     The SQL state for a
  42     <code>DataTruncation</code>
  43     is
  44     <code>01004</code>
  45     .
  46     </p>
  47  */
  48 published exception DataTruncation: SQLWarning
  49 {
  50
  51     /** is the index of the parameter or column value.
  52      */
  53     long Index;
  54
  55
  56     /** is
  57         <TRUE/>
  58         if a parameter value is truncated.
  59      */
  60     boolean IsParameter;
  61
  62
  63     /** is
  64         <TRUE/>
  65         if a read was truncated.
  66      */
  67     boolean DuringRead;
  68
  69
  70     /** contains the number of bytes of data that should have been transferred.
  71         This number may be approximate if data conversions were being
  72         performed. The value may be
  73         <code>-1</code>
  74         if the size is unknown.
  75      */
  76     long DataSize;
  77
  78
  79     /** contains the number of bytes of data actually transferred.
  80         The value may be
  81         <code>-1</code>
  82         if the size is unknown.
  83      */
  84     long TransferSize;
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90 /*===========================================================================
  91 ===========================================================================*/
  92 #endif