xref: /aoo41x/main/offapi/com/sun/star/sdbc/Driver.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_Driver_idl__
28#define __com_sun_star_sdbc_Driver_idl__
29
30 module com {  module sun {  module star {  module sdbc {
31
32 published interface XDriver;
33
34
35/** is the service that every driver class must implement.
36
37	<p>
38	Each driver should supply a service that implements
39	the Driver interface.
40
41	</p>
42	<p>
43	The DriverManager will try to load as many drivers as it can
44	find and then for any given connection request, it will ask each
45	driver in turn to try to connect to the target URL.
46
47	</p>
48	<p>
49	It is strongly recommended that each Driver object should be
50	small and standalone so that the Driver object can be loaded and
51	queried without bringing in vast quantities of supporting code.
52
53	</p>
54	<p>
55	Each driver should be a one instance service.
56
57	</p>
58	@see com::sun::star::sdbc::XDriverManager
59	@see com::sun::star::sdbc::XConnection
60 */
61published service Driver
62{
63
64	/** is the main interface to access a database driver.
65	 */
66	interface XDriver;
67};
68
69//=============================================================================
70
71}; }; }; };
72
73/*===========================================================================
74===========================================================================*/
75#endif
76