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

   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_DriverPropertyInfo_idl__
  28 #define __com_sun_star_sdbc_DriverPropertyInfo_idl__
  29
  30  module com {  module sun {  module star {  module sdbc {
  31
  32
  33 /** describes the driver properties for making a connection.
  34
  35
  36     <p>
  37     The DriverPropertyInfo is of interest only to advanced programmers
  38     who need to interact with a driver to discover and supply properties
  39     for connections.
  40     </p>
  41  */
  42 published struct DriverPropertyInfo
  43 {
  44     /** is the name of the property.
  45      */
  46     string Name;
  47
  48
  49     /** is a brief description of the property, which may be null.
  50      */
  51     string Description;
  52
  53
  54     /** is
  55         <TRUE/>
  56         if a value must be supplied for this property
  57         during
  58         <code>Driver.connect</code>
  59         and
  60         <FALSE/>
  61         otherwise.
  62      */
  63     boolean IsRequired;
  64
  65
  66     /** specifies the current value of the property,
  67         based on the driver-supplied default values.  This field
  68         may be empty if no value is known.
  69      */
  70     string Value;
  71
  72
  73     /** contains a sequence of possible values if the value for the field
  74             <code>DriverPropertyInfo.value</code>
  75             may be selected
  76             from a particular set of values; otherwise empty.
  77      */
  78     sequence<string> Choices;
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 /*===========================================================================
  86 ===========================================================================*/
  87 #endif