xref: /aoo42x/main/offapi/com/sun/star/sdbc/Driver.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_Driver_idl__
24cdf0e10cSrcweir#define __com_sun_star_sdbc_Driver_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir module com {  module sun {  module star {  module sdbc {
27cdf0e10cSrcweir
28cdf0e10cSrcweir published interface XDriver;
29cdf0e10cSrcweir
30cdf0e10cSrcweir
31cdf0e10cSrcweir/** is the service that every driver class must implement.
32cdf0e10cSrcweir
33cdf0e10cSrcweir	<p>
34cdf0e10cSrcweir	Each driver should supply a service that implements
35cdf0e10cSrcweir	the Driver interface.
36cdf0e10cSrcweir
37cdf0e10cSrcweir	</p>
38cdf0e10cSrcweir	<p>
39cdf0e10cSrcweir	The DriverManager will try to load as many drivers as it can
40cdf0e10cSrcweir	find and then for any given connection request, it will ask each
41cdf0e10cSrcweir	driver in turn to try to connect to the target URL.
42cdf0e10cSrcweir
43cdf0e10cSrcweir	</p>
44cdf0e10cSrcweir	<p>
45cdf0e10cSrcweir	It is strongly recommended that each Driver object should be
46cdf0e10cSrcweir	small and standalone so that the Driver object can be loaded and
47cdf0e10cSrcweir	queried without bringing in vast quantities of supporting code.
48cdf0e10cSrcweir
49cdf0e10cSrcweir	</p>
50cdf0e10cSrcweir	<p>
51cdf0e10cSrcweir	Each driver should be a one instance service.
52cdf0e10cSrcweir
53cdf0e10cSrcweir	</p>
54cdf0e10cSrcweir	@see com::sun::star::sdbc::XDriverManager
55cdf0e10cSrcweir	@see com::sun::star::sdbc::XConnection
56cdf0e10cSrcweir */
57cdf0e10cSrcweirpublished service Driver
58cdf0e10cSrcweir{
59cdf0e10cSrcweir
60cdf0e10cSrcweir	/** is the main interface to access a database driver.
61cdf0e10cSrcweir	 */
62cdf0e10cSrcweir	interface XDriver;
63cdf0e10cSrcweir};
64cdf0e10cSrcweir
65cdf0e10cSrcweir//=============================================================================
66cdf0e10cSrcweir
67cdf0e10cSrcweir}; }; }; };
68cdf0e10cSrcweir
69cdf0e10cSrcweir/*===========================================================================
70cdf0e10cSrcweir===========================================================================*/
71cdf0e10cSrcweir#endif
72