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

   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 #ifndef __com_sun_star_sdbc_BestRowScope_idl__
  28 #define __com_sun_star_sdbc_BestRowScope_idl__
  29
  30  module com {  module sun {  module star {  module sdbc {
  31
  32
  33 /** determines how long a row identifier is valid.
  34  */
  35 published constants BestRowScope
  36 {
  37
  38     /** indicates that the scope of the best row identifier is
  39              very temporary, lasting only while the row is being used.
  40              A possible value for the column
  41              <code>SCOPE</code>
  42              in the
  43              <type scope="com::sun::star::sdbc">XResultSet</type>
  44              object
  45              returned by the method
  46              <member>XDatabaseMetaData::getBestRowIdentifier()</member>
  47              .
  48      */
  49     const long TEMPORARY   = 0;
  50     //-------------------------------------------------------------------------
  51
  52     /** indicates that the scope of the best row identifier is
  53              the remainder of the current transaction.
  54              A possible value for the column
  55              <code>SCOPE</code>
  56              in the
  57              <type scope="com::sun::star::sdbc">XResultSet</type>
  58              object
  59              returned by the method
  60              <member>XDatabaseMetaData::getBestRowIdentifier()</member>
  61              .
  62      */
  63     const long TRANSACTION = 1;
  64     //-------------------------------------------------------------------------
  65
  66     /** indicates that the scope of the best row identifier is
  67              the remainder of the current session.
  68              A possible value for the column
  69              <code>SCOPE</code>
  70              in the
  71              <type scope="com::sun::star::sdbc">XResultSet</type>
  72              object
  73              returned by the method
  74              <member>XDatabaseMetaData::getBestRowIdentifier()</member>
  75              .
  76      */
  77     const long SESSION     = 2;
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 /*===========================================================================
  85 ===========================================================================*/
  86 #endif