offapi/com/sun/star/sdb/ParametersRequest.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdb_ParametersRequest_idl__
  28 #define __com_sun_star_sdb_ParametersRequest_idl__
  29
  30 #ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
  31 #include <com/sun/star/task/ClassifiedInteractionRequest.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37 #ifndef __com_sun_star_sdbc_XConnection_idl__
  38 #include <com/sun/star/sdbc/XConnection.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module sdb {
  44
  45 //=============================================================================
  46
  47 /** an error specifying the lack of parameters values
  48     <p>
  49     Usually thrown if someone tries to execute an SQL statement containing
  50     parameters which can't be filled by the executing instance.
  51     </p>
  52 */
  53 published exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
  54 {
  55     /** is the list of parameters requested.
  56         The objects returned by the
  57         <type scope="com::sun::star::container">XIndexAccess</type>
  58         have to
  59         be property sets describing the respective parameter. For this, the objects have to support the
  60         service <type scope="com::sun::star::sdbcx">Column</type>.
  61     */
  62     com::sun::star::container::XIndexAccess Parameters;
  63
  64     /** specifies the connection on which the statement is to be executed.
  65         Somebody handling the request could, e.g., use the connection for determining
  66         the identifier quote string, etc.
  67     */
  68     com::sun::star::sdbc::XConnection       Connection;
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 /*=============================================================================
  76
  77 =============================================================================*/
  78 #endif