offapi/com/sun/star/sdbc/ColumnSearch.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbc {
  21
  22
  23 /** indicates in which way a column can be used in the WHERE search.
  24  */
  25 published constants ColumnSearch
  26 {
  27
  28     /** A possible value for column <code>SEARCHABLE</code> in the
  29              com::sun::star::sdbc::XResultSet
  30              object returned by the method
  31              com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo().
  32              <p>
  33              Indicates that
  34              <code>WHERE</code>
  35              search clauses are not supported
  36              for this type.
  37      */
  38     const long NONE = 0;
  39
  40     /** A possible value for column <code>SEARCHABLE</code> in the
  41              com::sun::star::sdbc::XResultSet
  42              object returned by the method
  43              com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo().
  44              <p>
  45              Indicates that the only
  46              <code>WHERE</code>
  47              search clause that can
  48              be based on this type is
  49              <code>WHERE...LIKE</code>.
  50      */
  51     const long CHAR = 1;
  52
  53     /** A possible value for column <code>SEARCHABLE</code> in the
  54              com::sun::star::sdbc::XResultSet
  55              object returned by the method
  56              com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo().
  57              <p>
  58              Indicates that one can base all
  59              <code>WHERE</code>
  60              search clauses
  61              except
  62              <code>WHERE...LIKE</code>
  63              on this data type.
  64      */
  65     const long BASIC = 2;
  66
  67     /** A possible value for column
  68             <code>SEARCHABLE</code>
  69             in the
  70             com::sun::star::sdbc::XResultSet
  71             object returned by the method
  72             com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo().
  73             <p>
  74             Indicates that all
  75             <code>WHERE</code>
  76             search clauses can be
  77             based on this type.
  78      */
  79     const long FULL  = 3;
  80 };
  81
  82
  83 }; }; }; };
  84
  85 /*===========================================================================
  86 ===========================================================================*/
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */