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