offapi/com/sun/star/sdbc/ConnectionProperties.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ConnectionProperties.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_ConnectionProperties_idl__
  31 #define __com_sun_star_sdbc_ConnectionProperties_idl__
  32
  33  module com {  module sun {  module star {  module sdbc {
  34
  35
  36
  37 /** represents the properties for a connection (session) with a specific
  38     database. These properties can be used when calling the method
  39     <member scope="com::sun::star::sdbc">XDriver::connect()</member> or
  40     <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>.
  41
  42     <p>
  43     The properties for a connection contain additonal information about how to connect to a database and
  44     how to control the behavior of the resulting connection should be.
  45
  46     </p>
  47     @see com::sun::star::sdbc::XDriver
  48     @see com::sun::star::sdbc::XDriverManager
  49     @see com::sun::star::sdbc::JDBCConnectionProperties
  50     @see com::sun::star::sdbc::ODBCConnectionProperties
  51     @see com::sun::star::sdbc::FILEConnectionProperties
  52     @see com::sun::star::sdbc::DBASEConnectionProperties
  53     @see com::sun::star::sdbc::FLATConnectionProperties
  54
  55  */
  56 published service ConnectionProperties
  57 {
  58     /** the username
  59     */
  60     [optional, property] string user;
  61
  62     /** the password
  63     */
  64     [optional, property] string password;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 /*===========================================================================
  72
  73 ===========================================================================*/
  74 #endif