| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_sdb_InteractionHandler_idl__ |
| #define __com_sun_star_sdb_InteractionHandler_idl__ |
| |
| module com { module sun { module star { module task { |
| interface XInteractionHandler2; |
| }; }; }; }; |
| |
| module com { module sun { module star { module sdb { |
| |
| /** describes a service which is able to handle database-related interactions. |
| |
| <p>Usually, you will not instantiate this service directly. Instead, you'll instantiate a generic |
| <type scope="com::sun::star::task">InteractionHandler</type> service, and pass it your request. Based on |
| configuration data, this implementation will decide where to forward the request to.</p> |
| |
| <p>By default, the <code>DatabaseInteractionHandler</code> feels responsible (as per configuration) for the |
| following interaction types: |
| <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 interaction request supplies such a <code>SQLException</code> (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>parameter requests</b><br/> |
| If your interaction request 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 the entered information. |
| </li> |
| </ul> |
| </p> |
| */ |
| service DatabaseInteractionHandler: com::sun::star::task::XInteractionHandler2; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |