offapi/com/sun/star/sdbc/DataTruncation.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
  20  module com {  module sun {  module star {  module sdbc {
  21
  22
  23 /** reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception,
  24     on writes, when a data value is unexpectedly truncated.
  25
  26     <p>
  27     The SQL state for a
  28     <code>DataTruncation</code>
  29     is <code>01004</code>.
  30     </p>
  31  */
  32 published exception DataTruncation: SQLWarning
  33 {
  34
  35     /** is the index of the parameter or column value.
  36      */
  37     long Index;
  38
  39
  40     /** is
  41         `TRUE`
  42         if a parameter value is truncated.
  43      */
  44     boolean IsParameter;
  45
  46
  47     /** is
  48         `TRUE`
  49         if a read was truncated.
  50      */
  51     boolean DuringRead;
  52
  53
  54     /** contains the number of bytes of data that should have been transferred.
  55         This number may be approximate if data conversions were being
  56         performed. The value may be
  57         <code>-1</code>
  58         if the size is unknown.
  59      */
  60     long DataSize;
  61
  62
  63     /** contains the number of bytes of data actually transferred.
  64         The value may be
  65         <code>-1</code>
  66         if the size is unknown.
  67      */
  68     long TransferSize;
  69 };
  70
  71
  72 }; }; }; };
  73 /*===========================================================================
  74 ===========================================================================*/
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */