blob: 5f8e71473a2cb451187cde66ac491076302157b8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_sdbc_XDriverManager_idl__
#define __com_sun_star_sdbc_XDriverManager_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/PropertyValue.idl>
#include <com/sun/star/sdbc/SQLException.idl>
module com { module sun { module star { module sdbc {
published interface XConnection;
published interface XDriver;
/** is the basic interface for managing a set of SDBC drivers.
<p>
When the method
<member scope="com::sun::star::sdbc">XDriverManager::getConnection()</member>
is called,
the DriverManager will attempt to
locate a suitable driver.
</p>
@see com::sun::star::sdbc::XDriver
@see com::sun::star::sdbc::XConnection
*/
published interface XDriverManager: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** attempts to establish a connection to the given database URL.
The DriverManager attempts to select an appropriate driver from
the set of registered JDBC/SDBC drivers.
@param url
a database url of the form sdbc:subprotocol:subname
@returns
the Connection object
@throws SQLException
if a database access error occurs.
*/
XConnection getConnection([in]string url)
raises (SQLException);
//-------------------------------------------------------------------------
/** attempts to establish a connection to the given database URL.
The DriverManager attempts to select an appropriate driver from
the set of registered JDBC/SDBC drivers.
@param url
a database url of the form sdbc:subprotocol:subname
@param info
a list of arbitrary string tag/value pairs as connection arguments;
normally at least a "user" and "password" property should be included
@see com::sun::star::sdbc::ConnectionProperties
@returns
the Connection object
@throws SQLException
if a database access error occurs.
*/
XConnection getConnectionWithInfo([in]string url,
[in]sequence<com::sun::star::beans::PropertyValue> info)
raises (SQLException);
//-------------------------------------------------------------------------
/** sets the maximum time in seconds that a driver will wait
while attempting to connect to a database.
@param seconds
the login time limit in seconds
@throws SQLException
if a database access error occurs.
*/
void setLoginTimeout([in]long seconds);
//-------------------------------------------------------------------------
/** gets the maximum time in seconds that a driver can wait
when attempting to login to a database.
@returns
the driver login time limit in seconds
@throws SQLException
if a database access error occurs.
*/
long getLoginTimeout();
};
//=============================================================================
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
