1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_CallableStatement_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_sdbc_CallableStatement_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_PreparedStatement_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/sdbc/PreparedStatement.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski module com { module sun { module star { module sdbc { 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski published interface XRow; 33*b1cdbd2cSJim Jagielski published interface XOutParameters; 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski/** is used to execute SQL stored procedures. 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski <p> 40*b1cdbd2cSJim Jagielski SDBC provides a stored procedure SQL escape that allows stored procedures 41*b1cdbd2cSJim Jagielski to be called in a standard way for all RDBMSs. This escape syntax has one 42*b1cdbd2cSJim Jagielski form that includes a result parameter and one that does not. If used, the 43*b1cdbd2cSJim Jagielski result parameter must be registered as an OUT parameter. The other parameters 44*b1cdbd2cSJim Jagielski can be used for input, output, or both. Parameters are referred to sequentially, 45*b1cdbd2cSJim Jagielski by number. The first parameter is 1. 46*b1cdbd2cSJim Jagielski </p> 47*b1cdbd2cSJim Jagielski <p> 48*b1cdbd2cSJim Jagielski <code>{?=call&lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;,...]}<br/>{call&lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;,...]} 49*b1cdbd2cSJim Jagielski </code> 50*b1cdbd2cSJim Jagielski </p> 51*b1cdbd2cSJim Jagielski <p> 52*b1cdbd2cSJim Jagielski IN parameter values are set using the set methods inherited from 53*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">PreparedStatement</type> 54*b1cdbd2cSJim Jagielski . The type of all 55*b1cdbd2cSJim Jagielski OUT parameters must be registered prior to executing the stored procedure; 56*b1cdbd2cSJim Jagielski their values are retrieved after execution via the 57*b1cdbd2cSJim Jagielski <code>get</code> 58*b1cdbd2cSJim Jagielski methods 59*b1cdbd2cSJim Jagielski provided by the 60*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">XRow</type> 61*b1cdbd2cSJim Jagielski . 62*b1cdbd2cSJim Jagielski </p> 63*b1cdbd2cSJim Jagielski <p> 64*b1cdbd2cSJim Jagielski A 65*b1cdbd2cSJim Jagielski <code>CallableStatement</code> 66*b1cdbd2cSJim Jagielski can return one 67*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">XResultSet</type> 68*b1cdbd2cSJim Jagielski or multiple 69*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">ResultSet</type> 70*b1cdbd2cSJim Jagielski objects. Multiple 71*b1cdbd2cSJim Jagielski <code>ResultSet</code> 72*b1cdbd2cSJim Jagielski objects are 73*b1cdbd2cSJim Jagielski handled using operations inherited from 74*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">XPreparedStatement</type> 75*b1cdbd2cSJim Jagielski . 76*b1cdbd2cSJim Jagielski </p> 77*b1cdbd2cSJim Jagielski <p> 78*b1cdbd2cSJim Jagielski For maximum portability, a call's 79*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">ResultSet</type> 80*b1cdbd2cSJim Jagielski objects and 81*b1cdbd2cSJim Jagielski update counts should be processed prior to getting the values of output 82*b1cdbd2cSJim Jagielski parameters. 83*b1cdbd2cSJim Jagielski </p> 84*b1cdbd2cSJim Jagielski*/ 85*b1cdbd2cSJim Jagielskipublished service CallableStatement 86*b1cdbd2cSJim Jagielski{ 87*b1cdbd2cSJim Jagielski service PreparedStatement; 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** is used for retrieve the values of OUT parameters. 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski interface XRow; 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski /** is used to declare parameters as OUT parameters. 96*b1cdbd2cSJim Jagielski */ 97*b1cdbd2cSJim Jagielski interface XOutParameters; 98*b1cdbd2cSJim Jagielski}; 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski//============================================================================= 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski}; }; }; }; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski/*=========================================================================== 105*b1cdbd2cSJim Jagielski===========================================================================*/ 106*b1cdbd2cSJim Jagielski#endif 107