summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbc/ColumnSearch.idl
blob: bdb7afba35e54fdfd98d6f0687b6b97e520a88d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_ColumnSearch_idl__
#define __com_sun_star_sdbc_ColumnSearch_idl__

 module com {  module sun {  module star {  module sdbc {


/** indicates in which way a column can be used in the WHERE search.
 */
published constants ColumnSearch
{
    //-------------------------------------------------------------------------

    /** A possible value for column <code>SEARCHABLE</code> in the
             <type scope="com::sun::star::sdbc">XResultSet</type>
             object returned by the method
             <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
             .
             <p>
             Indicates that
             <code>WHERE</code>
             search clauses are not supported
             for this type.
     */
    const long NONE = 0;
    //-------------------------------------------------------------------------

    /** A possible value for column <code>SEARCHABLE</code> in the
             <type scope="com::sun::star::sdbc">XResultSet</type>
             object returned by the method
             <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
             .
             <p>
             Indicates that the only
             <code>WHERE</code>
             search clause that can
             be based on this type is
             <code>WHERE...LIKE</code>
             .
     */
    const long CHAR = 1;
    //-------------------------------------------------------------------------

    /** A possible value for column <code>SEARCHABLE</code> in the
             <type scope="com::sun::star::sdbc">XResultSet</type>
             object returned by the method
             <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
             .
             <p>
             Indicates that one can base all
             <code>WHERE</code>
             search clauses
             except
             <code>WHERE...LIKE</code>
             on this data type.
     */
    const long BASIC = 2;
    //-------------------------------------------------------------------------

    /** A possible value for column
            <code>SEARCHABLE</code>
            in the
            <type scope="com::sun::star::sdbc">XResultSet</type>
            object returned by the method
            <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
            .
            <p>
            Indicates that all
            <code>WHERE</code>
            search clauses can be
            based on this type.
     */
    const long FULL  = 3;
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif