offapi/com/sun/star/sdb/QueryDescriptor.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  module com {  module sun {  module star {  module sdbcx {
  21  published interface XDataDescriptorFactory;
  22  published interface XColumnsSupplier;
  23 };};};};
  24
  25  module com {  module sun {  module star {  module sdb {
  26
  27
  28 /** is a stored definition of a SQL "Select statement".
  29
  30     <p>
  31     It can be used, if there is a need to execute SQL statement more than once or
  32     if you want to format the query result fields different from the
  33     underlying table definitions.
  34     </p>
  35  */
  36 published service QueryDescriptor
  37 {
  38     service com::sun::star::sdbcx::Descriptor;
  39
  40
  41     /** is provided for creation of a new query descriptor based on the current information.
  42      */
  43     interface com::sun::star::sdbcx::XDataDescriptorFactory;
  44
  45
  46     /** is used for customization of data appearance.
  47      */
  48     service com::sun::star::sdb::DataSettings;
  49
  50
  51     /** access to the columns of the results sets query.
  52      */
  53     interface com::sun::star::sdbcx::XColumnsSupplier;
  54
  55
  56     /** is the command of the query, this is typically a select statement.
  57      */
  58     [property] string Command;
  59
  60
  61     /** should we use escape processing for the query.
  62      */
  63     [property] boolean EscapeProcessing;
  64
  65
  66     /** is the name of the table which should be updated. This is usually used
  67         for queries which relate on more than one table.
  68      */
  69     [property] string UpdateTableName;
  70
  71
  72     /** is the name of the update table catalog.
  73      */
  74     [property] string UpdateCatalogName;
  75
  76
  77     /** is the name of the update table schema.
  78      */
  79     [property] string UpdateSchemaName;
  80 };
  81
  82
  83 }; }; }; };
  84
  85 /*===========================================================================
  86 ===========================================================================*/
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */