/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DriverPropertyInfo.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 03:43:04 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_DriverPropertyInfo_idl__
#define __com_sun_star_sdbc_DriverPropertyInfo_idl__

 module com {  module sun {  module star {  module sdbc {


// DocMerge from xml: struct com::sun::star::sdbc::DriverPropertyInfo
/** describes the driver properties for making a connection.


    <p>
    The DriverPropertyInfo is of interest only to advanced programmers
    who need to interact with a driver to discover and supply properties
    for connections.
    </p>
 */
published struct DriverPropertyInfo
{
    // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Name
    /** is the name of the property.
     */
    string Name;


    // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Description
    /** is a brief description of the property, which may be null.
     */
    string Description;


    // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::IsRequired
    /** is
        <TRUE/>
        if a value must be supplied for this property
        during
        <code>Driver.connect</code>
        and
        <FALSE/>
        otherwise.
     */
    boolean IsRequired;


    // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::Value
    /** specifies the current value of the property,
        based on the driver-supplied default values.  This field
        may be empty if no value is known.
     */
    string Value;


    // DocMerge from idl: field com::sun::star::sdbc::DriverPropertyInfo::Choices
    /** contains a sequence of possible values if the value for the field
            <code>DriverPropertyInfo.value</code>
            may be selected
            from a particular set of values; otherwise empty.
     */
    sequence<string> Choices;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif
