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