offapi/com/sun/star/sdb/SingleSelectQueryComposer.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_SingleSelectQueryComposer_idl__
  28 #define __com_sun_star_sdb_SingleSelectQueryComposer_idl__
  29
  30 #ifndef __com_sun_star_sdb_SingleSelectQueryAnalyzer_idl__
  31 #include <com/sun/star/sdb/SingleSelectQueryAnalyzer.idl>
  32 #endif
  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 interface XSingleSelectQueryComposer;
  40 /** represents a service for composing a single select statement.
  41
  42     <p>
  43     It hides the complexity of parsing and evaluating a single select statement and provides
  44     sophisticated methods for expanding a statement with filter, group by, having and order
  45     criteria. To get the new extended statement use the methods from <type scope="com::sun::star::sdb">SingleSelectQueryAnalyzer</type>.
  46     </p>
  47
  48     <p>A <type>SingleSelectQueryComposer</type> is usually obtained from a <type>Connection</type>
  49     using the <type scope="com::sun::star::lang">XMultiServiceFactory</type> interface.</p>
  50  */
  51 service SingleSelectQueryComposer
  52 {
  53     // gives access to the properties.
  54     interface com::sun::star::beans::XPropertySet;
  55
  56     /** access to the analyzer service.
  57      */
  58     service SingleSelectQueryAnalyzer;
  59
  60     interface XSingleSelectQueryComposer;
  61
  62     /** is the orignal SQL statement set with the interface <type scope="com::sun::star::sdb">XSingleSelectQueryAnalyzer</type>.
  63     */
  64     [readonly, property] string Original;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 /*===========================================================================
  72 ===========================================================================*/
  73 #endif