xref: /AOO41X/main/offapi/com/sun/star/sdb/ParametersRequest.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_sdb_ParametersRequest_idl__
24#define __com_sun_star_sdb_ParametersRequest_idl__
25
26#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
27#include <com/sun/star/task/ClassifiedInteractionRequest.idl>
28#endif
29
30#ifndef __com_sun_star_container_XIndexAccess_idl__
31#include <com/sun/star/container/XIndexAccess.idl>
32#endif
33#ifndef __com_sun_star_sdbc_XConnection_idl__
34#include <com/sun/star/sdbc/XConnection.idl>
35#endif
36
37//=============================================================================
38
39 module com {  module sun {  module star {  module sdb {
40
41//=============================================================================
42
43/** an error specifying the lack of parameters values
44    <p>
45    Usually thrown if someone tries to execute an SQL statement containing
46    parameters which can't be filled by the executing instance.
47    </p>
48*/
49published exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
50{
51    /** is the list of parameters requested.
52        The objects returned by the
53        <type scope="com::sun::star::container">XIndexAccess</type>
54        have to
55        be property sets describing the respective parameter. For this, the objects have to support the
56        service <type scope="com::sun::star::sdbcx">Column</type>.
57    */
58    com::sun::star::container::XIndexAccess Parameters;
59
60    /** specifies the connection on which the statement is to be executed.
61        Somebody handling the request could, e.g., use the connection for determining
62        the identifier quote string, etc.
63    */
64    com::sun::star::sdbc::XConnection       Connection;
65};
66
67//=============================================================================
68
69}; }; }; };
70
71/*=============================================================================
72
73=============================================================================*/
74#endif
75