offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_DatabaseImportDescriptor_idl__
  21 #define __com_sun_star_sheet_DatabaseImportDescriptor_idl__
  22
  23 #include <com/sun/star/sheet/DataImportMode.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** represents a description of how data from an external database is
  30     imported.
  31
  32     @see com::sun::star::sheet::XDatabaseRange
  33  */
  34 published service DatabaseImportDescriptor
  35 {
  36
  37     /** enables importing and specifies from what type of source data is
  38         imported.
  39      */
  40     [property] com::sun::star::sheet::DataImportMode SourceType;
  41
  42
  43     /** specifies the name of the database from which data is imported.
  44      */
  45     [property] string DatabaseName;
  46
  47
  48     /** specifies the table, query, or statement from which data is imported.
  49
  50         <p>The meaning of this is determined by the
  51         DatabaseImportDescriptor::SourceType attribute.</p>
  52      */
  53     [property] string SourceObject;
  54
  55
  56     /** specifies whether the SQL statement is given directly to the database
  57         or is parsed before.
  58
  59         @since OOo 2.0
  60
  61      */
  62     [optional, property] boolean IsNative;
  63
  64
  65     /** indicates a connection URL, which locates a database driver.
  66         @since OOo 2.0
  67      */
  68     [optional, property] string ConnectionResource;
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */