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