summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbc/XWarningsSupplier.idl
blob: 31e3be1879e535331c800e66e748ab59010fdb6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

 module com {  module sun {  module star {  module sdbc {


/** should be implemented of objects which may report warnings or non critical
    errors.
    @see com::sun::star::sdbc::SQLWarning
 */
published interface XWarningsSupplier: com::sun::star::uno::XInterface
{

    /** returns the first warning reported by calls on an object that supports
        the usage of warnings.

        <p>
        <b>Note:</b> Subsequent warnings will be chained to this
        com::sun::star::sdbc::SQLWarning.
        </p>
        @returns
            the warnings
        @throws SQLException
                if a database access error occurs.
     */
    any getWarnings() raises (SQLException);


    /** clears all warnings reported for the object implementing the interface.
        After a call to this method, the method
        com::sun::star::sdbc::XWarningsSupplier::getWarnings()
        returns
        `VOID`
        until a new warning is reported for the object.
        @throws SQLException
                if a database access error occurs.
     */
    void clearWarnings() raises (SQLException);
};


}; }; }; };

/*===========================================================================
===========================================================================*/

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */