offapi/com/sun/star/sdb/InteractionHandler.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     published interface XInteractionHandler;
  35 }; }; }; };
  36
  37 module com {  module sun {  module star {  module sdb {
  38
  39 /**     is a service for user interaction for databases.
  40     <p>
  41     interaction requests that the handler can provide are:
  42     <ul>
  43         <li><b>database related errors</b><br/>
  44             The general structure to transport such errors is the
  45             <type scope="com::sun::star::sdbc">SQLException</type>
  46             , and if your
  47             <type scope="com::sun::star::task">XInteractionRequest</type>
  48             supplies such a
  49             <type scope="com::sun::star::sdbc">SQLException</type>
  50             (or an instance of any derived class),
  51             the handler will display a generic error dialog, which is able
  52             to travel the object chain which may be contained in the exception.
  53         </li>
  54         <li><b>authentication</b><br/>
  55             If your
  56             <type scope="com::sun::star::task">XInteractionRequest</type>
  57             (see
  58             <member scope="com::sun::star::task">XInteractionHandler::handle()</member>
  59             ) supplies a
  60             <type scope="com::sun::star::ucb">AuthenticationRequest</type>
  61             , the handler will open a standard login
  62             dialog to allow user authentication.
  63             <br/>
  64             Besides the using the members of the AuthenticationRequest in the usual manner, the member <em>Server</em>
  65             (if not empty) is interpreted as datasource name, thus leading to a slightly different message when
  66             requesting the user to enter it's login data.
  67             <br/>
  68             In the case you want to use this authentication feature, you should supply a special authentication
  69             continuation (
  70             <type scope="com::sun::star::ucb">XInteractionSupplyAuthentication</type>
  71             ) as well, so the
  72             handler can return to you, the entered information.
  73         </li>
  74         <li><b>parameter requests</b><br/>
  75             If your
  76             <type scope="com::sun::star::task">XInteractionRequest</type>
  77             supplies an
  78             <type scope="com::sun::star::sdb">ParametersRequest</type>
  79             , the handler will open a standard dialog asking
  80             the user to fill in parameter values.
  81             <br/>
  82             In the case you want to use this feature of the handler, you should supply a special continuation
  83             (
  84             <type scope="com::sun::star::sdb">XInteractionSupplyParameters</type>
  85             ) as well, so the
  86             handler can return to you, the entered information.
  87         </li>
  88     </ul>
  89     </p>
  90 */
  91 published service InteractionHandler: com::sun::star::task::XInteractionHandler;
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 #endif