xref: /trunk/main/offapi/com/sun/star/sdbc/ConnectionProperties.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_ConnectionProperties_idl__
28#define __com_sun_star_sdbc_ConnectionProperties_idl__
29
30 module com {  module sun {  module star {  module sdbc {
31
32
33
34/** represents the properties for a connection (session) with a specific
35    database. These properties can be used when calling the method
36    <member scope="com::sun::star::sdbc">XDriver::connect()</member> or
37    <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>.
38
39    <p>
40    The properties for a connection contain additonal information about how to connect to a database and
41    how to control the behavior of the resulting connection should be.
42
43    </p>
44    @see com::sun::star::sdbc::XDriver
45    @see com::sun::star::sdbc::XDriverManager
46    @see com::sun::star::sdbc::JDBCConnectionProperties
47    @see com::sun::star::sdbc::ODBCConnectionProperties
48    @see com::sun::star::sdbc::FILEConnectionProperties
49    @see com::sun::star::sdbc::DBASEConnectionProperties
50    @see com::sun::star::sdbc::FLATConnectionProperties
51
52 */
53published service ConnectionProperties
54{
55    /** the username
56    */
57    [optional, property] string user;
58
59    /** the password
60    */
61    [optional, property] string password;
62};
63
64//=============================================================================
65
66}; }; }; };
67
68/*===========================================================================
69
70===========================================================================*/
71#endif
72