/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: InteractionHandler.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 03:19:19 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_sdb_InteractionHandler_idl__
#define __com_sun_star_sdb_InteractionHandler_idl__

module com { module sun { module star { module task {
    published interface XInteractionHandler;
}; }; }; };

module com {  module sun {  module star {  module sdb {

/** is a service for user interaction for databases.
    <p>
    interaction requests that the handler can provide are:
    <ul>
        <li><b>database related errors</b><br/>
            The general structure to transport such errors is the
            <type scope="com::sun::star::sdbc">SQLException</type>
            , and if your
            <type scope="com::sun::star::task">XInteractionRequest</type>
            supplies such a
            <type scope="com::sun::star::sdbc">SQLException</type>
            (or an instance of any derived class),
            the handler will display a generic error dialog, which is able
            to travel the object chain which may be contained in the exception.
        </li>
        <li><b>authentication</b><br/>
            If your
            <type scope="com::sun::star::task">XInteractionRequest</type>
            (see
            <member scope="com::sun::star::task">XInteractionHandler::handle()</member>
            ) supplies a
            <type scope="com::sun::star::ucb">AuthenticationRequest</type>
            , the handler will open a standard login
            dialog to allow user authentication.
            <br/>
            Besides the using the members of the AuthenticationRequest in the usual manner, the member <em>Server</em>
            (if not empty) is interpreted as datasource name, thus leading to a slightly different message when
            requesting the user to enter it's login data.
            <br/>
            In the case you want to use this authentication feature, you should supply a special authentication
            continuation (
            <type scope="com::sun::star::ucb">XInteractionSupplyAuthentication</type>
            ) as well, so the
            handler can return to you, the entered information.
        </li>
        <li><b>parameter requests</b><br/>
            If your
            <type scope="com::sun::star::task">XInteractionRequest</type>
            supplies an
            <type scope="com::sun::star::sdb">ParametersRequest</type>
            , the handler will open a standard dialog asking
            the user to fill in parameter values.
            <br/>
            In the case you want to use this feature of the handler, you should supply a special continuation
            (
            <type scope="com::sun::star::sdb">XInteractionSupplyParameters</type>
            ) as well, so the
            handler can return to you, the entered information.
        </li>
    </ul>
    </p>
*/
published service InteractionHandler: com::sun::star::task::XInteractionHandler;

//=============================================================================

}; }; }; };

#endif
