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