xref: /AOO41X/main/offapi/com/sun/star/sdbc/XWarningsSupplier.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_XWarningsSupplier_idl__
24#define __com_sun_star_sdbc_XWarningsSupplier_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
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/** should be implemented of objects which may report warnings or non critical
38    errors.
39    @see com::sun::star::sdbc::SQLWarning
40 */
41published interface XWarningsSupplier: com::sun::star::uno::XInterface
42{
43    //-------------------------------------------------------------------------
44
45    /** returns the first warning reported by calls on an object that supports
46        the usage of warnings.
47
48        <p>
49        <b>Note:</b> Subsequent warnings will be chained to this
50        <type scope="com::sun::star::sdbc">SQLWarning</type>
51        .
52        </p>
53        @returns
54            the warnings
55        @throws SQLException
56                if a database access error occurs.
57     */
58    any getWarnings() raises (SQLException);
59
60    //-------------------------------------------------------------------------
61
62    /** clears all warnings reported for the object implementing the interface.
63        After a call to this method, the method
64        <member scope="com::sun::star::sdbc">XWarningsSupplier::getWarnings()</member>
65        returns
66        <void/>
67        until a new warning is reported for the object.
68        @throws SQLException
69                if a database access error occurs.
70     */
71    void clearWarnings() raises (SQLException);
72};
73
74//=============================================================================
75
76}; }; }; };
77
78/*===========================================================================
79===========================================================================*/
80#endif
81