xref: /AOO41X/main/offapi/com/sun/star/sdbc/DataTruncation.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_DataTruncation_idl__
24#define __com_sun_star_sdbc_DataTruncation_idl__
25
26#ifndef __com_sun_star_sdbc_SQLWarning_idl__
27#include <com/sun/star/sdbc/SQLWarning.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbc {
31
32
33/** reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception,
34    on writes, when a data value is unexpectedly truncated.
35
36    <p>
37    The SQL state for a
38    <code>DataTruncation</code>
39    is
40    <code>01004</code>
41    .
42    </p>
43 */
44published exception DataTruncation: SQLWarning
45{
46
47    /** is the index of the parameter or column value.
48     */
49    long Index;
50
51
52    /** is
53        <TRUE/>
54        if a parameter value is truncated.
55     */
56    boolean IsParameter;
57
58
59    /** is
60        <TRUE/>
61        if a read was truncated.
62     */
63    boolean DuringRead;
64
65
66    /** contains the number of bytes of data that should have been transferred.
67        This number may be approximate if data conversions were being
68        performed. The value may be
69        <code>-1</code>
70        if the size is unknown.
71     */
72    long DataSize;
73
74
75    /** contains the number of bytes of data actually transferred.
76        The value may be
77        <code>-1</code>
78        if the size is unknown.
79     */
80    long TransferSize;
81};
82
83//=============================================================================
84
85}; }; }; };
86/*===========================================================================
87===========================================================================*/
88#endif
89