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