offapi/com/sun/star/sdb/QueryDefinition.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 #ifndef __com_sun_star_sdb_QueryDefinition_idl__
  28 #define __com_sun_star_sdb_QueryDefinition_idl__
  29
  30 #ifndef __com_sun_star_beans_XPropertySet_idl__
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32 #endif
  33
  34  module com {  module sun {  module star {  module sdb {
  35
  36
  37 /** is a stored definition of a SQL "Select statement".
  38
  39     <p>
  40     It can be used, if there is a need to execute SQL statement more than once.
  41     </p>
  42  */
  43 published service QueryDefinition
  44 {
  45
  46     /** access to the owning database definition object.
  47      */
  48     interface com::sun::star::beans::XPropertySet;
  49
  50
  51     /** is the name of the definition.
  52      */
  53     [readonly, property] string Name;
  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 #endif