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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbc_CallableStatement_idl__
  20 #define __com_sun_star_sdbc_CallableStatement_idl__
  21
  22 #include <com/sun/star/sdbc/PreparedStatement.idl>
  23
  24  module com {  module sun {  module star {  module sdbc {
  25
  26  published interface XRow;
  27  published interface XOutParameters;
  28
  29
  30 /** is used to execute SQL stored procedures.
  31
  32
  33     <p>
  34     SDBC provides a stored procedure SQL escape that allows stored procedures
  35     to be called in a standard way for all RDBMSs. This escape syntax has one
  36     form that includes a result parameter and one that does not. If used, the
  37     result parameter must be registered as an OUT parameter. The other parameters
  38     can be used for input, output, or both. Parameters are referred to sequentially,
  39     by number. The first parameter is 1.
  40     </p>
  41     <p>
  42     <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;,...]}
  43     </code>
  44     </p>
  45     <p>
  46     IN parameter values are set using the set methods inherited from
  47     com::sun::star::sdbc::PreparedStatement
  48     . The type of all
  49     OUT parameters must be registered prior to executing the stored procedure;
  50     their values are retrieved after execution via the
  51     <code>get</code> methods provided by the com::sun::star::sdbc::XRow.
  52     </p>
  53     <p>
  54     A
  55     <code>CallableStatement</code>
  56     can return one
  57     com::sun::star::sdbc::XResultSet
  58     or multiple
  59     com::sun::star::sdbc::ResultSet
  60     objects. Multiple
  61     <code>ResultSet</code>
  62     objects are handled using operations inherited from
  63     com::sun::star::sdbc::XPreparedStatement.
  64     </p>
  65     <p>
  66     For maximum portability, a call's
  67     com::sun::star::sdbc::ResultSet
  68     objects and
  69     update counts should be processed prior to getting the values of output
  70     parameters.
  71     </p>
  72 */
  73 published service CallableStatement
  74 {
  75     service PreparedStatement;
  76
  77
  78     /** is used for retrieve the values of OUT parameters.
  79      */
  80     interface XRow;
  81
  82
  83     /** is used to declare parameters as OUT parameters.
  84      */
  85     interface XOutParameters;
  86 };
  87
  88
  89 }; }; }; };
  90
  91 /*===========================================================================
  92 ===========================================================================*/
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */