1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdb_InteractionHandler_idl__
24#define __com_sun_star_sdb_InteractionHandler_idl__
25
26module com { module sun { module star { module task {
27    interface XInteractionHandler2;
28}; }; }; };
29
30module com {  module sun {  module star {  module sdb {
31
32/**	describes a service which is able to handle database-related interactions.
33
34    <p>Usually, you will not instantiate this service directly. Instead, you'll instantiate a generic
35    <type scope="com::sun::star::task">InteractionHandler</type> service, and pass it your request. Based on
36    configuration data, this implementation will decide where to forward the request to.</p>
37
38    <p>By default, the <code>DatabaseInteractionHandler</code> feels responsible (as per configuration) for the
39    following interaction types:
40	<ul>
41		<li><b>database related errors</b><br/>
42			The general structure to transport such errors is the <type scope="com::sun::star::sdbc">SQLException</type>,
43            and if your interaction request supplies such a <code>SQLException</code> (or an instance of any derived class),
44			the handler will display a generic error dialog, which is able to travel the object chain which may be contained
45            in the exception.
46		</li>
47		<li><b>parameter requests</b><br/>
48			If your interaction request supplies an <type scope="com::sun::star::sdb">ParametersRequest</type>,
49            the handler will open a standard dialog asking the user to fill in parameter values.
50			<br/>
51			In the case you want to use this feature of the handler, you should supply a special continuation
52			(<type scope="com::sun::star::sdb">XInteractionSupplyParameters</type>) as well, so the
53			handler can return the entered information.
54		</li>
55	</ul>
56	</p>
57*/
58service DatabaseInteractionHandler: com::sun::star::task::XInteractionHandler2;
59
60//=============================================================================
61
62}; }; }; };
63
64#endif
65