offapi/com/sun/star/sdb/ParametersRequest.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: ParametersRequest.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_sdb_ParametersRequest_idl__
  31 #define __com_sun_star_sdb_ParametersRequest_idl__
  32
  33 #ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
  34 #include <com/sun/star/task/ClassifiedInteractionRequest.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XIndexAccess_idl__
  38 #include <com/sun/star/container/XIndexAccess.idl>
  39 #endif
  40 #ifndef __com_sun_star_sdbc_XConnection_idl__
  41 #include <com/sun/star/sdbc/XConnection.idl>
  42 #endif
  43
  44 //=============================================================================
  45
  46  module com {  module sun {  module star {  module sdb {
  47
  48 //=============================================================================
  49
  50 /** an error specifying the lack of parameters values
  51     <p>
  52     Usually thrown if someone tries to execute an SQL statement containing
  53     parameters which can't be filled by the executing instance.
  54     </p>
  55 */
  56 published exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
  57 {
  58     /** is the list of parameters requested.
  59         The objects returned by the
  60         <type scope="com::sun::star::container">XIndexAccess</type>
  61         have to
  62         be property sets describing the respective parameter. For this, the objects have to support the
  63         service <type scope="com::sun::star::sdbcx">Column</type>.
  64     */
  65     com::sun::star::container::XIndexAccess Parameters;
  66
  67     /** specifies the connection on which the statement is to be executed.
  68         Somebody handling the request could, e.g., use the connection for determining
  69         the identifier quote string, etc.
  70     */
  71     com::sun::star::sdbc::XConnection           Connection;
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 /*=============================================================================
  79
  80 =============================================================================*/
  81 #endif