offapi/com/sun/star/sheet/DatabaseImportDescriptor.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
  28 #ifndef __com_sun_star_sheet_DatabaseImportDescriptor_idl__
  29 #define __com_sun_star_sheet_DatabaseImportDescriptor_idl__
  30
  31 #ifndef __com_sun_star_sheet_DataImportMode_idl__
  32 #include <com/sun/star/sheet/DataImportMode.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module sheet {
  38
  39 //=============================================================================
  40
  41 /** represents a description of how data from an external database is
  42     imported.
  43
  44     @see com::sun::star::sheet::XDatabaseRange
  45  */
  46 published service DatabaseImportDescriptor
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** enables importing and specifies from what type of source data is
  51         imported.
  52      */
  53     [property] com::sun::star::sheet::DataImportMode SourceType;
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** specifies the name of the database from which data is imported.
  58      */
  59     [property] string DatabaseName;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** specifies the table, query, or statement from which data is imported.
  64
  65         <p>The meaning of this is determined by the
  66         <member>DatabaseImportDescriptor::SourceType</member> attribute.</p>
  67      */
  68     [property] string SourceObject;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** specifies whether the SQL statement is given directly to the database
  73         or is parsed before.
  74
  75         @since OOo 2.0.0
  76
  77      */
  78     [optional, property] boolean IsNative;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** indicates a connection URL, which locates a database driver.
  83         @since OOo 2.0.0
  84      */
  85     [optional, property] string ConnectionResource;
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif
  94