offapi/com/sun/star/sdb/ParametersRequest.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
  21  module com {  module sun {  module star {  module sdb {
  22
  23
  24 /** an error specifying the lack of parameters values
  25     <p>
  26     Usually thrown if someone tries to execute an SQL statement containing
  27     parameters which can't be filled by the executing instance.
  28     </p>
  29 */
  30 published exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest
  31 {
  32     /** is the list of parameters requested.
  33         The objects returned by the
  34         com::sun::star::container::XIndexAccess
  35         have to
  36         be property sets describing the respective parameter. For this, the objects have to support the
  37         service com::sun::star::sdbcx::Column.
  38     */
  39     com::sun::star::container::XIndexAccess Parameters;
  40
  41     /** specifies the connection on which the statement is to be executed.
  42         Somebody handling the request could, e.g., use the connection for determining
  43         the identifier quote string, etc.
  44     */
  45     com::sun::star::sdbc::XConnection       Connection;
  46 };
  47
  48
  49 }; }; }; };
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */