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