offapi/com/sun/star/sdb/QueryDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: QueryDescriptor.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdb_QueryDescriptor_idl__
  31 #define __com_sun_star_sdb_QueryDescriptor_idl__
  32
  33 #ifndef __com_sun_star_sdbcx_Descriptor_idl__
  34 #include <com/sun/star/sdbcx/Descriptor.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbcx {
  38  published interface XDataDescriptorFactory;
  39  published interface XColumnsSupplier;
  40 };};};};
  41
  42 #ifndef __com_sun_star_sdb_DataSettings_idl__
  43 #include <com/sun/star/sdb/DataSettings.idl>
  44 #endif
  45
  46  module com {  module sun {  module star {  module sdb {
  47
  48
  49 /** is a stored definition of a SQL "Select statement".
  50
  51     <p>
  52     It can be used, if there is a need to execute SQL statement more than once or
  53     if you want to format the query result fields different from the
  54     underlying table definitions.
  55     </p>
  56  */
  57 published service QueryDescriptor
  58 {
  59     service com::sun::star::sdbcx::Descriptor;
  60
  61
  62     /** is provided for creation of a new query descriptor based on the current information.
  63      */
  64     interface com::sun::star::sdbcx::XDataDescriptorFactory;
  65
  66
  67     /** is used for customization of data appearance.
  68      */
  69     service com::sun::star::sdb::DataSettings;
  70
  71
  72     /** access to the columns of the results sets query.
  73      */
  74     interface com::sun::star::sdbcx::XColumnsSupplier;
  75
  76
  77     /** is the command of the query, this is typically a select statement.
  78      */
  79     [property] string Command;
  80
  81
  82     /** should we use escape processing for the query.
  83      */
  84     [property] boolean EscapeProcessing;
  85
  86
  87     /** is the name of the table which should be updated. This is usually used
  88         for queries which relate on more than one table.
  89      */
  90     [property] string UpdateTableName;
  91
  92
  93     /** is the name of the update table catalog.
  94      */
  95     [property] string UpdateCatalogName;
  96
  97
  98     /** is the name of the update table schema.
  99      */
 100     [property] string UpdateSchemaName;
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 /*===========================================================================
 108 ===========================================================================*/
 109 #endif