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