offapi/com/sun/star/sdbc/XOutParameters.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: XOutParameters.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_XOutParameters_idl__
  31 #define __com_sun_star_sdbc_XOutParameters_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_sdbc_SQLException_idl__
  38 #include <com/sun/star/sdbc/SQLException.idl>
  39 #endif
  40
  41  module com {  module sun {  module star {  module sdbc {
  42
  43
  44 /** is used to register Out-Parameters for stored procedures.
  45
  46
  47     <p>
  48     SDBC provides a stored procedure SQL escape that allows stored procedures
  49     to be called in a standard way for all RDBMSs. This escape syntax has one
  50     form that includes a result parameter and one that does not. If used, the
  51     result parameter must be registered as an OUT parameter. The other parameters
  52     can be used for input, output, or both. Parameters are referred to sequentially,
  53     by number. The first parameter is 1.
  54     </p>
  55  */
  56 published interface XOutParameters: com::sun::star::uno::XInterface
  57 {
  58
  59     /** registers the designated output parameter.  This version of
  60         the method
  61         <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member>
  62         should be used for a user-named or REF output parameter. Examples
  63         of user-named types include: STRUCT, DISTINCT, OBJECT, and named array
  64         types.
  65
  66
  67         <p>
  68         Before executing a stored procedure call, you must explicitly
  69         call
  70         <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member>
  71         to register the type from
  72         <type scope="com::sun::star::sdbc">DataType</type>
  73         for each OUT parameter.
  74         <br/>
  75         For a user-named parameter the fully-qualified SQL type name of the
  76         parameter should also be given, while a REF parameter requires that the
  77         fully-qualified type name of the referenced type be given.
  78         An SDBC driver that does not need the type code and type name information
  79         may ignore it. To be portable, however, applications should always provide
  80         these values for user-named and REF parameters.
  81         </p>
  82         <p>Although it is intended for user-named and REF parameters,
  83         this method may be used to register a parameter of any SDBC type.
  84         If the parameter does not have a user-named or REF type, the
  85         typeName parameter is ignored.
  86         </p>
  87         <p>
  88         <b>Note:</b> When reading the value of an out parameter, you
  89         must use the
  90         <code>getXXX</code>
  91         method whose type XXX corresponds to the
  92         parameter's registered SQL type.
  93         </p>
  94         @param parameterIndex
  95             the first parameter is 1, the second is 2, ...
  96         @param sqlType
  97             the type of the column to register
  98         @param typeName
  99             the name of the type
 100         @throws SQLException
 101             if a database access error occurs.
 102      */
 103     void registerOutParameter([in]long parameterIndex, [in]long sqlType,
 104                               [in]string typeName)
 105         raises (SQLException);
 106     //-------------------------------------------------------------------------
 107
 108     /** registers the OUT parameter in ordinal position
 109         <code>parameterIndex</code>
 110         to the SDBC type
 111         <code>sqlType</code>
 112         . All
 113         OUT parameters must be registered before a stored procedure is executed.
 114
 115
 116         <p>
 117         The SDBC type specified by
 118         <code>sqlType</code>
 119         for an OUT parameter determines the type that must be used in the
 120         <code>get</code>
 121         method to read the value of that parameter.
 122         This version of
 123         <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member>
 124         should be
 125         used when the parameter is of SDBC type
 126         <member scope="com::sun::star::sdbc">DataType::NUMERIC</member>
 127         or
 128         <member scope="com::sun::star::sdbc">DataType::DECIMAL</member>
 129         .
 130         @param parameterIndex
 131             the first parameter is 1, the second is 2, ...
 132         @param sqlType
 133             the type of the column to register
 134         @param scale
 135             the scale of the type
 136         @throws SQLException
 137             if a database access error occurs.
 138         </p>
 139      */
 140     void registerNumericOutParameter([in]long parameterIndex, [in]long sqlType,
 141                                        [in]long scale)
 142         raises (SQLException);
 143 };
 144
 145 //=============================================================================
 146
 147 }; }; }; };
 148
 149 /*===========================================================================
 150 ===========================================================================*/
 151 #endif