/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_DatabaseImportDescriptor_idl__
#define __com_sun_star_sheet_DatabaseImportDescriptor_idl__

#ifndef __com_sun_star_sheet_DataImportMode_idl__
#include <com/sun/star/sheet/DataImportMode.idl>
#endif

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

module com {  module sun {  module star {  module sheet {

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

/** represents a description of how data from an external database is
    imported.

    @see com::sun::star::sheet::XDatabaseRange
 */
published service DatabaseImportDescriptor
{
    //-------------------------------------------------------------------------

    /** enables importing and specifies from what type of source data is
        imported.
     */
    [property] com::sun::star::sheet::DataImportMode SourceType;

    //-------------------------------------------------------------------------

    /** specifies the name of the database from which data is imported.
     */
    [property] string DatabaseName;

    //-------------------------------------------------------------------------

    /** specifies the table, query, or statement from which data is imported.

        <p>The meaning of this is determined by the
        <member>DatabaseImportDescriptor::SourceType</member> attribute.</p>
     */
    [property] string SourceObject;

    //-------------------------------------------------------------------------

    /** specifies whether the SQL statement is given directly to the database
        or is parsed before.

        @since OOo 2.0.0

     */
    [optional, property] boolean IsNative;

    //-------------------------------------------------------------------------

    /** indicates a connection URL, which locates a database driver.
        @since OOo 2.0.0
     */
    [optional, property] string ConnectionResource;

};

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

}; }; }; };

#endif

