xref: /AOO41X/main/offapi/com/sun/star/sdbc/ColumnSearch.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdbc_ColumnSearch_idl__
24#define __com_sun_star_sdbc_ColumnSearch_idl__
25
26 module com {  module sun {  module star {  module sdbc {
27
28
29/** indicates in which way a column can be used in the WHERE search.
30 */
31published constants ColumnSearch
32{
33    //-------------------------------------------------------------------------
34
35    /** A possible value for column <code>SEARCHABLE</code> in the
36             <type scope="com::sun::star::sdbc">XResultSet</type>
37             object returned by the method
38             <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
39             .
40             <p>
41             Indicates that
42             <code>WHERE</code>
43             search clauses are not supported
44             for this type.
45     */
46    const long NONE = 0;
47    //-------------------------------------------------------------------------
48
49    /** A possible value for column <code>SEARCHABLE</code> in the
50             <type scope="com::sun::star::sdbc">XResultSet</type>
51             object returned by the method
52             <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
53             .
54             <p>
55             Indicates that the only
56             <code>WHERE</code>
57             search clause that can
58             be based on this type is
59             <code>WHERE...LIKE</code>
60             .
61     */
62    const long CHAR = 1;
63    //-------------------------------------------------------------------------
64
65    /** A possible value for column <code>SEARCHABLE</code> in the
66             <type scope="com::sun::star::sdbc">XResultSet</type>
67             object returned by the method
68             <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
69             .
70             <p>
71             Indicates that one can base all
72             <code>WHERE</code>
73             search clauses
74             except
75             <code>WHERE...LIKE</code>
76             on this data type.
77     */
78    const long BASIC = 2;
79    //-------------------------------------------------------------------------
80
81    /** A possible value for column
82            <code>SEARCHABLE</code>
83            in the
84            <type scope="com::sun::star::sdbc">XResultSet</type>
85            object returned by the method
86            <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
87            .
88            <p>
89            Indicates that all
90            <code>WHERE</code>
91            search clauses can be
92            based on this type.
93     */
94    const long FULL  = 3;
95};
96
97//=============================================================================
98
99}; }; }; };
100
101/*===========================================================================
102===========================================================================*/
103#endif
104