offapi/com/sun/star/sdbc/ColumnSearch.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: ColumnSearch.idl,v $
  10  * $Revision: 1.9 $
  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 #ifndef __com_sun_star_sdbc_ColumnSearch_idl__
  31 #define __com_sun_star_sdbc_ColumnSearch_idl__
  32
  33  module com {  module sun {  module star {  module sdbc {
  34
  35
  36 /** indicates in which way a column can be used in the WHERE search.
  37  */
  38 published constants ColumnSearch
  39 {
  40     //-------------------------------------------------------------------------
  41
  42     /** A possible value for column <code>SEARCHABLE</code> in the
  43              <type scope="com::sun::star::sdbc">XResultSet</type>
  44              object returned by the method
  45              <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
  46              .
  47              <p>
  48              Indicates that
  49              <code>WHERE</code>
  50              search clauses are not supported
  51              for this type.
  52      */
  53     const long NONE = 0;
  54     //-------------------------------------------------------------------------
  55
  56     /** A possible value for column <code>SEARCHABLE</code> in the
  57              <type scope="com::sun::star::sdbc">XResultSet</type>
  58              object returned by the method
  59              <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
  60              .
  61              <p>
  62              Indicates that the only
  63              <code>WHERE</code>
  64              search clause that can
  65              be based on this type is
  66              <code>WHERE...LIKE</code>
  67              .
  68      */
  69     const long CHAR = 1;
  70     //-------------------------------------------------------------------------
  71
  72     /** A possible value for column <code>SEARCHABLE</code> in the
  73              <type scope="com::sun::star::sdbc">XResultSet</type>
  74              object returned by the method
  75              <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
  76              .
  77              <p>
  78              Indicates that one can base all
  79              <code>WHERE</code>
  80              search clauses
  81              except
  82              <code>WHERE...LIKE</code>
  83              on this data type.
  84      */
  85     const long BASIC = 2;
  86     //-------------------------------------------------------------------------
  87
  88     /** A possible value for column
  89             <code>SEARCHABLE</code>
  90             in the
  91             <type scope="com::sun::star::sdbc">XResultSet</type>
  92             object returned by the method
  93             <member  scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member>
  94             .
  95             <p>
  96             Indicates that all
  97             <code>WHERE</code>
  98             search clauses can be
  99             based on this type.
 100      */
 101     const long FULL  = 3;
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 /*===========================================================================
 109 ===========================================================================*/
 110 #endif