summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/ParametersRequest.idl
blob: a9a199f70ffb3ef77427438fdfbfe95373843b77 (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*************************************************************************
 *
 *  $RCSfile: ParametersRequest.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_sdb_ParametersRequest_idl__ 
#define __com_sun_star_sdb_ParametersRequest_idl__ 
 
#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__ 
#include <com/sun/star/task/ClassifiedInteractionRequest.idl> 
#endif 
 
#ifndef __com_sun_star_container_XIndexAccess_idl__ 
#include <com/sun/star/container/XIndexAccess.idl> 
#endif 
#ifndef __com_sun_star_sdbc_XConnection_idl__ 
#include <com/sun/star/sdbc/XConnection.idl> 
#endif 

//============================================================================= 
 
 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>
*/
exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
{ 
    /** is the list of parameters requested.
        The objects returned by the 
        <type scope="com.sun.star.container">XIndexAccess</type>
        have to
        be property sets describing the respective parameter. For this, the objects have to support the
        service 
        <service scope="com.sun.star.sdbcx">
        Column
        </service>
        .
    */
    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; 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.4.2.1  2002/02/18 10:22:59  oj
    #97563# parameter,return value and exception description
    
    Revision 1.4  2001/10/25 15:00:32  mi
    proofreading and corrections from Richard Holt
    
    Revision 1.3  2000/11/08 12:43:31  mi
    moved from api
    
    Revision 1.2  2000/10/26 18:01:49  fs
    documentation changed / added the Connection member, as it's very necessary to fullfill such a request
    
    Revision 1.1.1.1  2000/09/18 23:35:36  hjs
    initial import
    
=============================================================================*/ 
#endif