offapi/com/sun/star/sdb/BooleanComparisonMode.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: BooleanComparisonMode.idl,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef __com_sun_star_sdb_BooleanComparisonMode_idl__
  32 #define __com_sun_star_sdb_BooleanComparisonMode_idl__
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module sdb {
  37
  38 //=============================================================================
  39
  40 /** specifies different modi how boolean comparison predicates are to be generated
  41     by a <type>SingleSelectQueryComposer</type>.
  42  */
  43 constants BooleanComparisonMode
  44 {
  45     /** denotes the default comparison
  46
  47         <p>Most databases support comparing boolean expressions or column values directly with
  48         integer values: <code><em>column</em> = 0</code> respectively <code><em>column</em> = 1</code>.</p>
  49     */
  50     const long EQUAL_INTEGER    = 0;
  51
  52     /** requires to use <code>IS <em>boolean_literal</em></code> for boolean comparison.
  53
  54         <p>That is, the generated comparison predicates will be <code><em>column</em> IS TRUE</code> resp.
  55         <code><em>column</em> IS FALSE</code>.</p>
  56     */
  57     const long IS_LITERAL       = 1;
  58
  59     /** requires to use <code>= <em>boolean_literal</em></code> for boolean comparison.
  60
  61         <p>That is, the generated comparison predicates will be <code><em>column</em> = TRUE</code> resp.
  62         <code><em>column</em> = FALSE</code>.</p>
  63     */
  64     const long EQUAL_LITERAL    = 2;
  65
  66     /** requires to use an Microsoft Access compatible syntax for boolean comparison.
  67     */
  68     const long ACCESS_COMPAT    = 3;
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 //=============================================================================
  76
  77 #endif