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_sdbc_CallableStatement_idl__ 24#define __com_sun_star_sdbc_CallableStatement_idl__ 25 26#ifndef __com_sun_star_sdbc_PreparedStatement_idl__ 27#include <com/sun/star/sdbc/PreparedStatement.idl> 28#endif 29 30 module com { module sun { module star { module sdbc { 31 32 published interface XRow; 33 published interface XOutParameters; 34 35 36/** is used to execute SQL stored procedures. 37 38 39 <p> 40 SDBC provides a stored procedure SQL escape that allows stored procedures 41 to be called in a standard way for all RDBMSs. This escape syntax has one 42 form that includes a result parameter and one that does not. If used, the 43 result parameter must be registered as an OUT parameter. The other parameters 44 can be used for input, output, or both. Parameters are referred to sequentially, 45 by number. The first parameter is 1. 46 </p> 47 <p> 48 <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 </code> 50 </p> 51 <p> 52 IN parameter values are set using the set methods inherited from 53 <type scope="com::sun::star::sdbc">PreparedStatement</type> 54 . The type of all 55 OUT parameters must be registered prior to executing the stored procedure; 56 their values are retrieved after execution via the 57 <code>get</code> 58 methods 59 provided by the 60 <type scope="com::sun::star::sdbc">XRow</type> 61 . 62 </p> 63 <p> 64 A 65 <code>CallableStatement</code> 66 can return one 67 <type scope="com::sun::star::sdbc">XResultSet</type> 68 or multiple 69 <type scope="com::sun::star::sdbc">ResultSet</type> 70 objects. Multiple 71 <code>ResultSet</code> 72 objects are 73 handled using operations inherited from 74 <type scope="com::sun::star::sdbc">XPreparedStatement</type> 75 . 76 </p> 77 <p> 78 For maximum portability, a call's 79 <type scope="com::sun::star::sdbc">ResultSet</type> 80 objects and 81 update counts should be processed prior to getting the values of output 82 parameters. 83 </p> 84*/ 85published service CallableStatement 86{ 87 service PreparedStatement; 88 89 90 /** is used for retrieve the values of OUT parameters. 91 */ 92 interface XRow; 93 94 95 /** is used to declare parameters as OUT parameters. 96 */ 97 interface XOutParameters; 98}; 99 100//============================================================================= 101 102}; }; }; }; 103 104/*=========================================================================== 105===========================================================================*/ 106#endif 107