1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_CallableStatement_idl__
28#define __com_sun_star_sdbc_CallableStatement_idl__
29
30#ifndef __com_sun_star_sdbc_PreparedStatement_idl__
31#include <com/sun/star/sdbc/PreparedStatement.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdbc {
35
36 published interface XRow;
37 published interface XOutParameters;
38
39
40/** is used to execute SQL stored procedures.
41
42
43	<p>
44	SDBC provides a stored procedure SQL escape that allows stored procedures
45	to be called in a standard way for all RDBMSs. This escape syntax has one
46	form that includes a result parameter and one that does not. If used, the
47	result parameter must be registered as an OUT parameter. The other parameters
48	can be used for input, output, or both. Parameters are referred to sequentially,
49	by number. The first parameter is 1.
50	</p>
51	<p>
52	<code>{?=call&amp;lt;procedure-name&amp;gt;[&amp;lt;arg1&amp;gt;,&amp;lt;arg2&amp;gt;,...]}<br/>{call&amp;lt;procedure-name&amp;gt;[&amp;lt;arg1&amp;gt;,&amp;lt;arg2&amp;gt;,...]}
53	</code>
54	</p>
55	<p>
56	IN parameter values are set using the set methods inherited from
57	<type scope="com::sun::star::sdbc">PreparedStatement</type>
58	. The type of all
59	OUT parameters must be registered prior to executing the stored procedure;
60	their values are retrieved after execution via the
61	<code>get</code>
62	methods
63	provided by the
64	<type scope="com::sun::star::sdbc">XRow</type>
65	.
66	</p>
67	<p>
68	A
69	<code>CallableStatement</code>
70	can return one
71	<type scope="com::sun::star::sdbc">XResultSet</type>
72	or multiple
73	<type scope="com::sun::star::sdbc">ResultSet</type>
74	objects. Multiple
75	<code>ResultSet</code>
76	objects are
77	handled using operations inherited from
78	<type scope="com::sun::star::sdbc">XPreparedStatement</type>
79	.
80	</p>
81	<p>
82	For maximum portability, a call's
83	<type scope="com::sun::star::sdbc">ResultSet</type>
84	objects and
85	update counts should be processed prior to getting the values of output
86	parameters.
87	</p>
88*/
89published service CallableStatement
90{
91	service PreparedStatement;
92
93
94	/** is used for retrieve the values of OUT parameters.
95	 */
96	interface XRow;
97
98
99	/** is used to declare parameters as OUT parameters.
100	 */
101	interface XOutParameters;
102};
103
104//=============================================================================
105
106}; }; }; };
107
108/*===========================================================================
109===========================================================================*/
110#endif
111