offapi/com/sun/star/sdb/DatabaseInteractionHandler.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: InteractionHandler.idl,v $
  10  * $Revision: 1.12 $
  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_InteractionHandler_idl__
  31 #define __com_sun_star_sdb_InteractionHandler_idl__
  32
  33 module com { module sun { module star { module task {
  34     interface XInteractionHandler2;
  35 }; }; }; };
  36
  37 module com {  module sun {  module star {  module sdb {
  38
  39 /** describes a service which is able to handle database-related interactions.
  40
  41     <p>Usually, you will not instantiate this service directly. Instead, you'll instantiate a generic
  42     <type scope="com::sun::star::task">InteractionHandler</type> service, and pass it your request. Based on
  43     configuration data, this implementation will decide where to forward the request to.</p>
  44
  45     <p>By default, the <code>DatabaseInteractionHandler</code> feels responsible (as per configuration) for the
  46     following interaction types:
  47     <ul>
  48         <li><b>database related errors</b><br/>
  49             The general structure to transport such errors is the <type scope="com::sun::star::sdbc">SQLException</type>,
  50             and if your interaction request supplies such a <code>SQLException</code> (or an instance of any derived class),
  51             the handler will display a generic error dialog, which is able to travel the object chain which may be contained
  52             in the exception.
  53         </li>
  54         <li><b>parameter requests</b><br/>
  55             If your interaction request supplies an <type scope="com::sun::star::sdb">ParametersRequest</type>,
  56             the handler will open a standard dialog asking the user to fill in parameter values.
  57             <br/>
  58             In the case you want to use this feature of the handler, you should supply a special continuation
  59             (<type scope="com::sun::star::sdb">XInteractionSupplyParameters</type>) as well, so the
  60             handler can return the entered information.
  61         </li>
  62     </ul>
  63     </p>
  64 */
  65 service DatabaseInteractionHandler: com::sun::star::task::XInteractionHandler2;
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif