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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com {  module sun {  module star {  module sdb {
  21
  22 interface XSingleSelectQueryComposer;
  23 /** represents a service for composing a single select statement.
  24
  25     <p>
  26     It hides the complexity of parsing and evaluating a single select statement and provides
  27     sophisticated methods for expanding a statement with filter, group by, having and order
  28     criteria. To get the new extended statement use the methods from com::sun::star::sdb::SingleSelectQueryAnalyzer.
  29     </p>
  30
  31     <p>A SingleSelectQueryComposer is usually obtained from a Connection
  32     using the com::sun::star::lang::XMultiServiceFactory interface.</p>
  33  */
  34 service SingleSelectQueryComposer
  35 {
  36     // gives access to the properties.
  37     interface com::sun::star::beans::XPropertySet;
  38
  39     /** access to the analyzer service.
  40      */
  41     service SingleSelectQueryAnalyzer;
  42
  43     interface XSingleSelectQueryComposer;
  44
  45     /** is the original SQL statement set with the interface com::sun::star::sdb::XSingleSelectQueryAnalyzer.
  46     */
  47     [readonly, property] string Original;
  48 };
  49
  50
  51 }; }; }; };
  52
  53 /*===========================================================================
  54 ===========================================================================*/
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */