offapi/com/sun/star/sdb/QueryDefinition.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: QueryDefinition.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_QueryDefinition_idl__
  31 #define __com_sun_star_sdb_QueryDefinition_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdb {
  38
  39
  40 /** is a stored definition of a SQL "Select statement".
  41
  42     <p>
  43     It can be used, if there is a need to execute SQL statement more than once.
  44     </p>
  45  */
  46 published service QueryDefinition
  47 {
  48
  49     /** access to the owning database definition object.
  50      */
  51     interface com::sun::star::beans::XPropertySet;
  52
  53
  54     /** is the name of the definition.
  55      */
  56     [readonly, property] string Name;
  57
  58
  59     /** is the command of the query, this is typically a select statement.
  60      */
  61     [property] string Command;
  62
  63
  64     /** should we use escape processing for the query.
  65      */
  66     [property] boolean EscapeProcessing;
  67
  68
  69     /** is the name of the table which should be updated. This is usually used
  70         for queries which relate on more than one table.
  71      */
  72     [property] string UpdateTableName;
  73
  74
  75     /** is the name of the update table catalog.
  76      */
  77     [property] string UpdateCatalogName;
  78
  79
  80     /** is the name of the update table schema.
  81      */
  82     [property] string UpdateSchemaName;
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 /*===========================================================================
  90 ===========================================================================*/
  91 #endif