summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdb/ParametersRequest.idl
blob: 9e44f9c50c1dc74fe80ed43ae5a87d8079aba54d (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
/* -*- 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 .
 */
#ifndef __com_sun_star_sdb_ParametersRequest_idl__
#define __com_sun_star_sdb_ParametersRequest_idl__

#include <com/sun/star/task/ClassifiedInteractionRequest.idl>

#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/sdbc/XConnection.idl>


 module com {  module sun {  module star {  module sdb {


/** an error specifying the lack of parameters values
    <p>
    Usually thrown if someone tries to execute an SQL statement containing
    parameters which can't be filled by the executing instance.
    </p>
*/
published exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
{
    /** is the list of parameters requested.
        The objects returned by the
        com::sun::star::container::XIndexAccess
        have to
        be property sets describing the respective parameter. For this, the objects have to support the
        service com::sun::star::sdbcx::Column.
    */
    com::sun::star::container::XIndexAccess Parameters;

    /** specifies the connection on which the statement is to be executed.
        Somebody handling the request could, e.g., use the connection for determining
        the identifier quote string, etc.
    */
    com::sun::star::sdbc::XConnection       Connection;
};


}; }; }; };

#endif

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