offapi/com/sun/star/sdbc/CallableStatement.idl

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